Click or drag to resize

DocumentVersionsAppendDocumentVersionInformation(CAEXFileType, String, String, String) Method

This function sets the DocumentVersion information for a referenced document. If DocumentVersion information about the same document Identifier already exists, this DocumentVersion information is replaced.

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

Parameters

caexFile  CAEXFileType
the CAEXFile of the AutomationML document
documentIdentifier  String
The "DocumentIdentifier" shall define the name of the referenced document.
documentVersion  String
The "Version" shall define the version range of the referenced document. The version number shall have three numbers separated by ".".
error  String
Out parameter with error information if provided values are not valid or null. 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 information is 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