back to content

sign up free version control plan

SAWHSDK::checkoutProject

Description

Checks out a entire project from the server.

Syntax

int checkoutProject(
        String strProjectFullNameToCheckout,
        String strLocalDir,
        String strComment,
        boolean bExclusivelyCheckout,
        boolean bDoNotGetLocalCopy,
        boolean bRecursive,
        int enumModifiedFileHandling,
        int enumEOL,
        int enumCompareFileBy,
        int enumSetLocalFileTime,
        BaseDataProject bdobCanceled,
        BaseDataProject bdostrError,
        ItemOperateResultArray aryOperatorResult
);

Parameters

strProjectFullNameToCheckout
[in] Specifies the full name of the project to be checked out.

strLocalDir
[in] Specifies the path of local directory to which the project will be retrieved.

strComment
[in] Specifies the comment for the checkout action.

bExclusivelyCheckout
[in] Specifies whether the folders will be checked out exclusively.

bDoNotGetLocalCopy
[in] Specifies whether to get local copy of the project. TRUE indicates not to get local copies.

bRecursive
[in] Specifies whether the project will be checked out recursively.

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 for files.

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

• EnumModifiedFileHandling Enumeration
• EnumEOL Enumeration
• EnumCompareFileBy Enumeration
• EnumSetLocalFileTime Enumeration
• ItemOperateResultArray Class Array

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.