back to content

sign up free version control plan

ISAWHAppObject::GetLatestProject

Description

Retrieves the latest version of a project from the server.

Syntax

long GetLatestProject(
        BSTR ProjectToGet,
        BSTR LocalFolder,
        VARIANT_BOOL Recursive,
        VARIANT_BOOL MakeWritable,
        Enum_ModifiedFileHandling ModifiedFileHandling,
        Enum_EOL EOL,
        Enum_CompareFileBy CompareFileBy,
        Enum_SetLocalFileTime SetLocalFileTime,
        ISAWHDiffMergeParam* MergeParam,
        VARIANT_BOOL* Cancelled,
        BSTR* ResultDescription,
        ISAWHOperationResultSet* OperationResultSet
);

Parameters

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

LocalFolder
[in] Specifies the local path to which the project is retrieved.

Recursive
[in] Specifies whether the folder is to be retrieved recursively.

MakeWritable
[in] Specifies whether to make the file writable after being retrieved from the server.

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

EOL
[in] Specifies which end-of-line terminator is to be used for files.

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

SetLocalFileTime
[in] Specifies the type of time to be assigned to the local file.

MergeParam
[in] Specifies the parameters used for merge.

Cancelled
[out] If the method fails, returns whether the operation is cancelled.

ResultDescription
[out] Returns the description of the return value. If the method succeeds, returns 'Completed'. If the method fails, returns the description of the error.

OperationResultSet
[out] Returns the result information set of the operation.

Return Value

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

See Also

• ISAWHDiffMergeParam Interface
• ISAWHOperationResultSet Interface
• Enum_ModifiedFileHandling Enumeration
• Enum_EOL Enumeration
• Enum_CompareFileBy Enumeration
• Enum_SetLocalFileTime Enumeration

Sample

VB Sample:

Dim WithEvents sdkObject As SAWHSDKLib.SAWHAppObject

Set sdkObject = New SAWHSDKLib.SAWHAppObject

Private Sub GetLatestProject()

	Dim ProjectToGet As String
	Dim LocalFolder As String
	Dim Cancelled As Boolean
	Dim ResultDescription As String
	Dim MergeParam As New SAWHDiffMergeParam
	Dim OperationResultSet As New SAWHOperationResultSet
	Dim arrTempOperationResult As New SAWHOperationResultSet

	dlgLatestProjects.Text1.Text = "$/Project1"
	dlgLatestProjects.Text2.Text = "D:\Personal Folder\test"
	dlgLatestProjects.Show 1, Me
	ProjectToGet = dlgLatestProjects.Text1.Text
	LocalFolder = dlgLatestProjects.Text2.Text

	Dim ResultValue As Long
	ResultValue = sdkObject.GetLatestProject(ProjectToGet, LocalFolder, False, False, Enum_ReplaceModifiedFile, Enum_EOLNative, Enum_CompareFileByChecksum, Enum_SetLocalFileTimeCurrent, MergeParam, Cancelled, ResultDescription, OperationResultSet)

	If ResultValue <> 0 Then
		MsgBox ("Failed to get the latest version of the project.")
	End If

End Sub