Connection.CheckoutDocument Method

Transitions the document to a state where it can be edited, either a QuickChange or UnderChange in workflow depending on the optional quickchange parameter

Namespace: ICMeridianAPI
Assembly: ICMeridianAPI (in ICMeridianAPI.dll) Version: 4.0.9.0 (4.0.9.0)

Syntax

C++

Copy

public void CheckoutDocument(
	string vaultidentifier,
	string docid,
	string comment = "",
	bool quickchange = false
)

Public Sub CheckoutDocument ( 
	vaultidentifier As String,
	docid As String,
	Optional comment As String = "",
	Optional quickchange As Boolean = false
)

public:
void CheckoutDocument(
	String^ vaultidentifier, 
	String^ docid, 
	String^ comment = L"", 
	bool quickchange = false
)

Parameters

vaultidentifier: Type: SystemString
The vault in which the document resides.
docid: Type: SystemString
The unique identifier of the document inside the vault.
comment (Optional): Type: SystemString
Optional comment to be written in the comment log of the document.
quickchange (Optional): Type: SystemBoolean
Optional Boolean. Use True to create a Quick Change.

Remarks

Reference

Connection Class

ICMeridianAPI Namespace