WorkSite.CheckoutDocument Method (String, Int32, Int32, WorkSite.PathCreationOption)

WorkSiteCheckoutDocument Method (String, Int32, Int32, WorkSitePathCreationOption)

Mocom WorkSite Library API

Checks out a copy of the latest version of a WorkSite document to a specified path.

Namespace: Mocom_WorkSite_Library
Assembly: Mocom WorkSite Library (in Mocom WorkSite Library.dll) Version: 1.0.8.0 (1.0.8)

Syntax

Copy

public string CheckoutDocument(
	string path,
	int documentNumber,
	int documentVer,
	WorkSitePathCreationOption option
)

Public Function CheckoutDocument ( 
	path As String,
	documentNumber As Integer,
	documentVer As Integer,
	option As WorkSitePathCreationOption
) As String

Parameters

path: Type: SystemString
The folder path (without filename) to copy the document to.
documentNumber: Type: SystemInt32
The document number of the file you want to copy.
documentVer: Type: SystemInt32
The version number of the file to be copied.
option: Type: Mocom_WorkSite_LibraryWorkSitePathCreationOption
Specify the PathCreationOption to

Return Value

Type: String
The full path and filename of the checked out document.

Remarks

PLEASE NOTE: The local path and filename of the checked out document is recorded by WorkSite. Therefore, when the document is checked back. in, it will fail if the document is moved or renamed.

Reference

WorkSite Class

CheckoutDocument Overload

Mocom_WorkSite_Library Namespace