back to content

sign up free version control plan

SAWHSDK::undoCheckoutProject

Description

Undoes checkout of a project.

Syntax

int undoCheckoutProject(
        String strProjectFullNameToUndoCheckout,
        String strLocalDir,
        boolean bRecursive,
        int enumLocalFileHandling,
        int enumUndoCheckOutChangedFileHandling,
        int enumCompareFileBy,
        int enumEOL,
        boolean bUseReadOnly,
        int enumSetLocalFileTime,
        BaseDataObject bdobCandeled,
        BaseDataObject bdostrError,
      ItemOperateResultArray aryOperatorResult
);

Parameters

strProjectFullNameToUndoCheckout
[in] Specifies the full name of the project to be undone checkout.

strLocalDir
[in] Specifies the path of local directory of the project.

bRecursive
[in] Specifies whether the checkout is to be undone recursively.

enumLocalFileHandling
[in] Specifies how to handle the local copy of file.

enumUndoCheckOutChangedFileHandling
[in] Specifies how to handle the file if the local copy has been changed

enumCompareFileBy
[in] Specifies how to determine if the local copy of the file is up-to-date, by checksum or date/time.

enumEOL
[in] Specifies which end-of-line terminator is to be used.

bUseReadonly
[in] Specifies whether to use read-only flag on files that are not checked out.

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 set of the operation.

Return Value

If the method succeeds, returns 0. If the method fails, returns other error codes.

See Also

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

Note: If local copies of the files under the project are modified AND the parameter "enumUndoCheckOutChangedFileHandling" is set to the enum "enumAskUndoCheckOutChangedFile" AND the parameter "enumLocalFileHandling" is set to enum "enumReplaceLocalFile" or enum "enumDeleteLocalFile", the method "PromptUndoCheckoutChangedFiles()" will be triggered.