back to content

sign up free version control plan

ISAWHAppObject::GetLatestFiles

Description

Retrieves the latest version of files from the repository.

Syntax

long GetLatestFiles(
        ISAWHLatestFileSet LatestFileSet,
        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

LatestFileSet
[in] Specifies the name set of files to be retrieved from the server.

MakeWritable
[in] Specifies whether to make the local file writable after it is 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

• ISAWHLatestFileSet Interface
• 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 GetLatestFiles_Click()

	Dim Cancelled As Boolean
	Dim ResultDescription As String
	Dim LatestFileSet As New SAWHLatestFileSet
	Dim LatestFile As New SAWHLatestFile
	Dim OperationResultSet As New SAWHOperationResultSet
	Dim MergeParam As New SAWHDiffMergeParam

	LatestFile.FileToGet = "$/FileName.txt"
	LatestFile.LocalFileName = "D:\LocalFileName.txt"
	LatestFileSet.Add LatestFile

	Dim ResultValue As Long
	ResultValue = sdkObject.GetLatestFiles(LatestFileSet, True, 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 files."
	End If

End Sub