online source control
back to content
sign up free version control plan

SAWHSDK::addFolder

Description

Adds an entire local folder to the server.

Syntax

int addFolder(
        String
strProjectFullName,
        String
strLocalFolderToAdd,
        Boolean
bRecursive,
        String
strComment,
        Boolean
bUseReadOnly,
        int
enumFileType,
        int enumCompareFileBy,
        int enumSetLocalFileTime,
        boolean bRemoveLocalCopy,

        BaseDataObject
bdobCanceled,
        BaseDataObject
bdostrError,
        ItemOperateResultArray
aryOperatorResult
);

Parameters

strProjectFullName
[in] Specifies the full name of the project under which the local folder will be added.

strLocalFolderToAdd
[in] Specifies the full name of the local folder to be added.

bRecursive
[in] Specifies whether the folder will be added recursively.

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

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

enumFileType
[in] Specifies the types of files in the folder that is to be added.

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

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

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

bdobCanceled
[out] If the method fails, returns whether the operation is canceled.

bdoError
[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