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

ISAWHAppObject::GetFileCheckoutStatus

Description

Retrieves the checkout status information of a file.

Syntax

long GetFileCheckoutStatus(
        BSTR FileName,
        ISAWHCheckoutFileStatusSet* CheckoutFileStatusSet,

       
VARIANT_BOOL* Cancelled,
        BSTR* ResultDescription
);

Parameters

FileName
[in] Specifies the full name of the file.

CheckoutFileStatusSet
[out] Returns the checkout status information of the file.

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 GetFileCheckoutStatus_Click()
	Dim Cancelled As Boolean
	Dim ResultDescription As String
	Dim CheckoutFileStatusSet As New SAWHCheckoutFileStatusSet

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

	Dim ResultValue As Long
	ResultValue = sdkObject.GetFileCheckoutStatus(FileName, CheckoutFileStatusSet, Cancelled, ResultDescription)

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

	Dim Count As Long
	Count = CheckoutFileStatusSet.GetCount
	Dim Index As Long
	For Index = 0 To Count - 1
		Dim CheckoutFileStatus As New SAWHCheckoutFileStatus
		CheckoutFileStatusSet.Get Index, CheckoutFileStatus
		Dim DateTime As Date
		DateTime = CheckoutFileStatus.CheckoutDateTime
		Dim UserName As String
		UserName = CheckoutFileStatus.CheckoutUserName
		Dim Comment As String
		Comment = CheckoutFileStatus.Comment
		Dim VersionNumberLow As Long
		VersionNumberLow = CheckoutFileStatus.VersionNumberLow
		Dim VersionNumberHigh As Long
		VersionNumberHigh = CheckoutFileStatus.VersionNumberHigh
	Next

End Sub