back to content

sign up free version control plan

SAWHSDK::getOldVersionFileByLabel

Description

Retrieves an old version of a file from server by label.

Syntax

int getOldVersionFileByLabel(
        String strFileFullNameToGet,
        String strLabelName,
        String strLocalFileFullName,
        boolean bMakeWritable,
        int enumModifiedFileHandling,
        int enumEOL,
        int enumCompareFileBy,
        int enumSetLocalFileTime,
        SDiffMergeParameters stDiffMergeParameters,
        BaseDataObject bdobCanceled,
        BaseDataObject bdostrError
);

Parameters

strFileFullNameToGet
[in] Specifies the full name of the file to be retrieved.

strLabelName
[in] Specifies the label name of the labeled file version to be retrieved.

strLocalFileFullName
[in] Specifies the full name of the local file to which the server file will be retrieved.

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

enumModifiedFileHandling
[in] Specifies how to handle the local file if a writable copy of the file exists 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 the local file.

stDiffMergeParameters
[in] Specifies the parameters of the diff or 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.

Return Value

If the method succeeds, returns 0. If the method fails, returns other error codes.

See Also

• EnumModifiedFileHandling Enumeration
• EnumEOL Enumerationn
• EnumCompareFileBy Enumerationn
• EnumSetLocalFileTime Enumeration
• SDiffMergeParameters Class

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