back to content

sign up free version control plan

SAWHSDK::undoCheckoutFiles

Description

Undoes checkout of multiple files.

Syntax

int undoCheckoutFiles(
       StringArray aryFileFullNameToUndoCheckout,
       StringArray aryLocalFileFullName,
      int enumLocalFileHandling,
      int enumUndoCheckOutChangedFileHandling,
      int enumCompareFileBy,
      int enumEOL,
      boolean bUseReadOnly,
      int enumSetLocalFileTime,
      BaseDataObject bdobCanceled,
      BaseDataObject bdostrError,
      ItemOperateResultArray aryOperatorResult
);

Parameters

aryFileFullNameToUndoCheckout
[in] Specifies the full names of files to be undone checkout.

aryLocalFileFullName
[in] Specifies the full names of the local copies of files.

enumLocalFileHandling
[in] Specifies how to handle the local files after the checkout is undone.

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 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
• EnumSetLocalFileTime Enumeration
• EnumUndoCheckOutChangedFileHandling Enumeration
• ItemOperateResultArray Class Array

Note: If local copies of the files 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.