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

WorkSiteCheckoutDocument Method (String, Int32, WorkSitePathCreationOption, String, WorkSiteDocumentFileExtensionOptions)

Mocom WorkSite Library API

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

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,
	WorkSitePathCreationOption option,
	string copiedDocumentName,
	WorkSiteDocumentFileExtensionOptions fileExtensionOption
)

Public Function CheckoutDocument ( 
	path As String,
	documentNumber As Integer,
	option As WorkSitePathCreationOption,
	copiedDocumentName As String,
	fileExtensionOption As WorkSiteDocumentFileExtensionOptions
) 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.
option: Type: Mocom_WorkSite_LibraryWorkSitePathCreationOption
Specify the PathCreationOption to
copiedDocumentName: Type: SystemString
The filename to call the copied document.
fileExtensionOption: Type: Mocom_WorkSite_LibraryWorkSiteDocumentFileExtensionOptions
The option for automatically adding a file extension to the supplied filename.

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.

Reference

WorkSite Class

CheckoutDocument Overload

Mocom_WorkSite_Library Namespace