SAWVSDK::undoCheckoutFiles

Description

Undoes checkout of multiple files.

Syntax

int undoCheckoutFiles(
        StringArray strAryFileToUndo,
        StringArray strAryLocalFile,
        int iEnumEOL,
        int iEnumSetLocalFileTime,
        int iEnumLocalFileHandling,
        int iEnumUndoCheckOutChangeFileHandling,
        boolean bUseReadonlyForFileNotCheckedOut,
        BaseDataObject bdobCandeled,
        BaseDataObject bdostrError,
        ResultArray aryResult
);

Parameters

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

strAryLocalFile
[in] Specifies the local names of files to be undone checkout.

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

iEnumSetLocalFileTime
[in] Specifies the type of time to be assigned to local files.

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

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

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

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

• EnumEOL Enumerationn
• EnumSetLocalFileTime Enumeration
• EnumLocalFileHandling Enumeration
• EnumUndoCheckOutChangedFileHandling Enumeration

Note: If the local copies of the files are modified and the parameter "iEnumUndoCheckOutChangeFileHandling" is set to the enum "enumAskUndoCheckOutChangedFile", the method "PromptUndoCheckoutChangedFiles()" will be triggered.