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

SAWHSDK::getLatestFiles

Description

Retrieves the latest version of files from the server.

Syntax

int getLatestFiles(
        StringArray aryFileToGet,
        StringArray aryLocalFile,
        boolean bMakeWritable,
        int enumModifiedFileHandling,
        int enumEOL,
        int enumCompareFileBy,
        int enumSetLocalFileTime,
        SDiffMergeParameters stDiffMergeParameters,
        BaseDataObject bdobCandeled,
        BaseDataObject bdostrError,
        ItemOperateResultArray aryOperatorResult
);

Parameters

aryFileToGet
[in] Specifies the full names of files to be retrieved from the server.

aryLocalFile
[in] Specifies the full names of local files to which the server files will be retrieved.

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

enumModifiedFileHandling
[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.

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.

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

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

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