back to content

sign up free version control plan

SAWHSDK::getOldVersionProjectByLabel

Description

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

Syntax

int getOldVersionProjectByLabel(
      String strProjectFullName,
      String strLocalDirectory,
        String strLabelName,
      boolean bRecursive,
      boolean bMakeWritable,
      int enumCompareFileBy,
      int enumEOL,
      int enumModifiedFileHandling,
      int enumSetLocalFileTime,
      SDiffMergeParameters stDiffMergeParameters,
      BaseDataObject bdobCanceled,
      BaseDataObject bdostrError,
      ItemOperateResultArray aryOperatorResult
);

Parameters

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

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

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

bRecursive
[in] Specifies whether to retrieve the project recursively.

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

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

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

enumModifiedFileHandling
[in] Specifies how to handle the local file if a writable copy of the file exists in the local disk.

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.

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

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

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