M_AML_DocumentVersion_DocumentVersions_AppendDocumentVersionInformation

DocumentVersions.AppendDocumentVersionInformation Method (CAEXFileType, DocumentVersionInformation, String)

Appends the provided document version information to the AutomationML document

Namespace: AML.DocumentVersion
Assembly: AMLEngineExtensions (in AMLEngineExtensions.dll) Version: 3.5

Syntax

C#

public static bool AppendDocumentVersionInformation(
	this CAEXFileType myCAEXFile,
	DocumentVersionInformation versionInformation,
	out string error
)

C++

public:
[ExtensionAttribute]
static bool AppendDocumentVersionInformation(
	CAEXFileType^ myCAEXFile, 
	DocumentVersionInformation^ versionInformation, 
	[OutAttribute] String^% error
)

Parameters

 

myCAEXFile

Type: CAEX_ClassModel.CAEXFileType
The caex file of the AutomationML document.

versionInformation

Type: AML.DocumentVersion.DocumentVersionInformation
The version information.

error

Type: System.String
Out parameter containing error information if the method returns false. Possibles errors are:  

• No Document Identifier defined
• DocumentVersion to be parsed is null
• Negative value in version string
• Bad number of components in version string
• Non-integer value in version string
• Number out of range in version string

Return Value

Type: Boolean
true if the version information could be added, false otherwise.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type CAEXFileType. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

See Also

Reference

DocumentVersions Class
AppendDocumentVersionInformation Overload
AML.DocumentVersion Namespace