SAWVSDK::checkoutProject

Description

Checks out a project to specified directory path.

Syntax

int checkoutProject(
        String strProjectToCheckout,
        String strLocalDirectory,
        String strComment,
        boolean bDoNotGetLocalCopy,
        boolean bRecursive,
        int ienumWritableFileHandling,
        int ienumEOL,
        int ienumSetLocalFileTime,
        BaseDataProject bdobCanceled,
        BaseDataProject bdostrError,
        ResultArray aryResult
);

Parameters

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

strLocalDirectory
[in] Specifies local directory path to which the project is checked out.

strComment
[in] Specifies the comment for the checkout.

bRecursive
[in] Specifies whether the folders are to be checked out recursively.

bMakeWritable
[in] Specifies whether to make the files writable.

ienumWritableFileHandling
[in] Specifies how to handle the local files if writable copies of them exist in the local disk.

ienumEOL
[in] Specifies which end-of-line terminator is to be used for files.

ienumSetLocalFileTime
[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.

aryResult
[out] Returns the result information set of the operation.

Return Value

If the method succeeds, returns the value of ESAWV_SUCCESS. If the method fails, returns other error codes.

See Also

• EnumWritableFileHandling Enumeration
• EnumEOL Enumeration
• EnumSetLocalFileTime Enumeration