SAWVSDK::getProjectByLabel

Description

Retrieves a project from the Dynamsoft SourceAnywhere for VSS server by label.

Syntax

int getProjectByLabel(
        String strProjectToGet,
        String strLocalDirectory,
        String strLabel,
        boolean bRecursive,
        boolean bMakeWritable,
        int enumWritableFileHandling,
        int enumEOL,
        int enumSetLocalFileTime,
        BaseDataObject bdobCanceled,
        BaseDataObject bdostrError,
        ResultArray aryResult
);

Parameters

strProjectToGet
[in] Specifies the name of the project to be retrieved.

strLocalDirectory
[in] Specifies the path of the local folder to which the project will be retrieved.

strLabel
[in] Specifies the name of label.

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

bMakeWritable
[in] Specifies whether to make the files writable.

enumWritableFileHandling
[in] Specifies how to handle the local files if writable copies of them exist in the local disk.

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

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.

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

• EnumWritableFileHandling Enumeration
• EnumEOL Enumerationn
• EnumSetLocalFileTime Enumeration

Note: If the local copies of the files in the project exist and the parameter "ienumWritableFileHandling" is set to the enum "AskWritableFile", the method  "PromptLeaveOrReplaceWritableFile()" will be triggered.