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

ISAWHAppObject::GetFilesStatus

Description

Gets the status information of files.

Syntax

long GetFilesStatus(
        ISAWHFileStatusInSet* FileStatusInSet,
        ISAWHFileStatusOutSet* FileStatusOutSet,

       
VARIANT_BOOL* Cancelled,
        BSTR* ResultDescription
);

Parameters

FileStatusInSet
[in] Specifies the full name set of the files.

FileStatusOutSet
[out] Returns the status set of the files.

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

ResultDescription
[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

Sample

VB Sample:

Dim WithEvents sdkObject As SAWHSDKLib.SAWHAppObject

Set sdkObject = New SAWHSDKLib.SAWHAppObject

Private Sub GetFileStatus_Click()

	Dim Cancelled As Boolean
	Dim ResultDescription As String
	Dim FileStatusInSet As New SAWHFileStatusInSet
	Dim FileStatusOutSet As New SAWHFileStatusOutSet

	Dim FileName As String
	FileName = "$/FileName.txt"
	FileStatusInSet.Add FileName

	Dim ResultValue As Long
	ResultValue = sdkObject.GetFilesStatus(FileStatusInSet, FileStatusOutSet, Cancelled, ResultDescription)

	If ResultValue <> 0 Then
		MsgBox "Failed to get the file status."
		Exit Sub
	End If

	Dim Count As Long
	Count = FileStatusOutSet.GetCount
	Dim Index As Long
	For Index = 0 To Count - 1
		Dim FileStatusOut As New SAWHFileStatusOut
		FileStatusOutSet.Get Index, FileStatusOut
		Dim FileStatus As Enum_ItemStatus
		FileStatus = FileStatusOut.FileStatus
		Dim IsCheckoutByMe As Boolean
		IsCheckoutByMe = FileStatusOut.IsCheckoutByMe
		Dim IsExists As Boolean
		IsExists = FileStatusOut.IsExists
	Next

End Sub