DocumentVersionsReplaceDocumentVersionInformation Method

This function replaces any existing DocumentVersion information corresponding to the identical oldDocumentID with the provided new DocumentVersion information.

Namespace: Aml.Engine.AmlObjects
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2

Syntax

C++

Copy

public static bool ReplaceDocumentVersionInformation(
	this CAEXFileType caexFile,
	string oldDocumentID,
	DocumentVersionInformation newDocumentVersionInformation,
	out string error
)

<ExtensionAttribute>
Public Shared Function ReplaceDocumentVersionInformation ( 
	caexFile As CAEXFileType,
	oldDocumentID As String,
	newDocumentVersionInformation As DocumentVersionInformation,
	<OutAttribute> ByRef error As String
) As Boolean

public:
[ExtensionAttribute]
static bool ReplaceDocumentVersionInformation(
	CAEXFileType^ caexFile, 
	String^ oldDocumentID, 
	DocumentVersionInformation^ newDocumentVersionInformation, 
	[OutAttribute] String^% error
)

Parameters

caexFile CAEXFileType: The CAEX file of the AutomationML document.
oldDocumentID String: Document identifier of the old DocumentVersion information
newDocumentVersionInformation DocumentVersionInformation: substitute for the old version of DocumentVersion information
error String: error information if provided values are invalid

Return Value

Boolean
true if succeeded, false if DocumentVersion information corresponding to the oldDocumentID is not found

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).

Reference

DocumentVersions Class

Aml.Engine.AmlObjects Namespace