back to content

sign up free version control plan

SAWHSDK::checkInFiles

Description

Checks in multiple files.

Syntax

int checkInFiles(
        StringArray aryFilesFullNameToCheckIn,
        StringArray aryLocalFile,
        String bKeepCheckout,
        boolean bRemoveLocalCopy,
        int enumCompareFileBy,
        int enumEOL,
        boolean bUseReadOnly,
        int enumSetLocalFileTime,
        int enumCheckinUnchangedFileHandling,
        String strComment,
        SDiffMergeParameters stDiffMergeParameters,
        boolean bForceCheckin,
        BaseDataObject bdobCanceled,
        BaseDataObject bdostrError,
        ItemOperateResultArray aryOperatorResult
);

Parameters

aryFilesFullNameToCheckIn
[in] Specifies the full names of files to which the local files will be checked in.

aryLocalFile
[in] Specifies the full names of local files to be checked in.

bKeepCheckout
[in] Specifies whether to keep files checked out to you.

bRemoveLocalCopy
[in] Specifies whether to remove local copies of the files after checkin.

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.

enumCheckinUnchangedFileHandling
[in] Specifies how to handle the unchanged files, checking in or undoing checkout.

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

stDiffMergeParameters
[in] Specifies parameters for the diff or merge.

bForceCheckin
[in] Specifies whether to force the checkin.

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

• EnumEOL Enumeration
• EnumSetLocalFileTime Enumeration
• EnumCompareFileBy Enumeration
• EnumCheckinUnchangedFileHandling Enumeration
• SDiffMergeParameters Class
• ItemOperateResultArray Class Array

Note: If local copies of the files under the project are not modified AND the parameter "enumCheckinUnchangedFileHandling" is set to the enum "AskCheckinUnchangedFile", the method "PromptCheckinOrUndoUnchangedFile()" will be triggered.