Click or drag to resize

DocumentVersionsAppendDocumentVersionInformation(CAEXFileType, DocumentVersionInformation, String) Method

Appends the provided document version information to the AutomationML document

Namespace: Aml.Engine.AmlObjects
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntax
Copy
public static bool AppendDocumentVersionInformation(
	this CAEXFileType caexFile,
	DocumentVersionInformation versionInformation,
	out string error
)

Parameters

caexFile  CAEXFileType
The CAEX file of the AutomationML document.
versionInformation  DocumentVersionInformation
The version information.
error  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

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