Connection.GetDocumentLocation Method

ConnectionGetDocumentLocation Method

Returns a full path in UNC format or the relative path within the vault that can be used by any Windows application to read from or write to a document. The document needs to be in the Under Change state for it to be writable.

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

Syntax

C++

Copy

public string GetDocumentLocation(
	string vaultidentifier,
	string docid,
	bool relativepath = false
)

Public Function GetDocumentLocation ( 
	vaultidentifier As String,
	docid As String,
	Optional relativepath As Boolean = false
) As String

public:
String^ GetDocumentLocation(
	String^ vaultidentifier, 
	String^ docid, 
	bool relativepath = false
)

member GetDocumentLocation : 
        vaultidentifier : string * 
        docid : string * 
        ?relativepath : bool 
(* Defaults:
        let _relativepath = defaultArg relativepath false
*)
-> string

Parameters

vaultidentifier: Type: SystemString
The vault in which the document resides.
docid: Type: SystemString
The unique identifier of the document inside the vault.
relativepath (Optional): Type: SystemBoolean
Optional Boolean. True to return a relative path, False to return an absolute path.

Return Value

Type: String
Path to the document

Remarks

For this method to work with a full path, AMFS needs to be running.

Reference

Connection Class

ICMeridianAPI Namespace