SAWVSDK::checkInProject

Description

Checks in a project.

Syntax

int checkInProject(
        String strProjectToCheckIn,
        String strLocalDir,
        String strComment,
        boolean bRecursive,
        boolean bKeep Checkout,
        boolean bRemoveLocalCopy,
        int iEnumEOL,
        int iEnumSetLocalFileTime,
        int iEnumCheckinUnchangedFileHandling,
        boolean bUseReadonlyForFileNotCheckedOut,
        BaseDataObject bdobCandeled,
        BaseDataObject bdostrError,
        ResultArray aryResult
);

Parameters

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

strLocalDir
[in] Specifies the local directory path from which the project is checked in.

strComment
[in] Specifies the comment for the check-in.

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

bKeep Checkout
[in] Specifies whether to keep files in the project checked out to you.

bRemoveLocalCopy
[in] Specifies whether to remove the local file copies after the project is checked in.

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.

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

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 Enumeration
• EnumSetLocalFileTime Enumeration
• EnumCheckinUnchangedFileHandling Enumeration

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