SAWHSDK::checkoutFiles
Description
Checks out multiple files from the server.
Syntax
int checkoutFiles(
StringArray
aryFilesFullNameToCheckout,
StringArray
aryLocalFileFullName,
boolean
bExclusivelyCheckout,
String strComment,
boolean bDoNotGetLocalCopy,
int enumModifiedFileHandling,
int enumEOL,
int enumCompareFileBy,
int enumSetLocalFileTime,
BaseDataProject bdobCanceled,
BaseDataProject bdostrError,
ItemOperateResultArray
aryOperatorResult
);
Parameters
aryFilesFullNameToCheckout
[in] Specifies the full names of files to be checked out.
aryLocalFileFullName
[in] Specifies the full names of local files to which the files will be checked out.
bExclusivelyCheckout
[in] Specifies whether the folders will be checked out exclusively.
strComment
[in] Specifies the comment for the checkout action.
bDoNotGetLocalCopy
[in] Specifies whether to get local copies of the files. TRUE indicates not to
get local copies.
enumModifiedFileHandling
[in] Specifies how to handle the local files if writable copies of them
exist in the local disk.
enumEOL
[in] Specifies which end-of-line terminator is to be used.
enumCompareFileBy
[in] Specifies how to determine if the local copy of the file is up-to-date, by checksum or date/time.
enumSetLocalFileTime
[in] Specifies the type of time to be assigned to local files.
bdobCanceled
[out] If the method fails, returns whether the operation is canceled.
bdostrError
[out] Returns the description of the result. If the operation succeeds, returns
'Completed'. If the operation fails, returns the error information.
aryOperatorResult
[out] Returns the result information of the operation.
Return Value
If the method succeeds, returns 0. If the method fails, returns other error codes.
See Also
Note: If the files to be checked out exist in local disk and the parameter "enumModifiedFileHandling" is set to the enum "enumAskModifiedFile", the method "PromptLeaveOrReplaceWritableFile()" will be triggered.