ISAWHAppObject::GetFilesCommonInfo
Description
Retrieves the common information of files.
Syntax
long GetFilesCommonInfo(
ISAWHFileCommonInfoSet*
FileCommonInfoSet,
VARIANT_BOOL* Cancelled,
BSTR* ResultDescription
);
Parameters
FileCommonInfoSet
[in, out] Specifies or returns general information about 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 GetFilesCommonInfo_Click() Dim Cancelled As Boolean Dim ResultDescription As String Dim FileCommonInfoSet As New SAWHFileCommonInfoSet Dim FileCommonInfo As New SAWHFileCommonInfo FileCommonInfo.FileName = "$/FileName.txt" FileCommonInfoSet.Add FileCommonInfo Dim ResultValue As Long ResultValue = sdkObject.GetFilesCommonInfo(FileCommonInfoSet, Cancelled, ResultDescription) If ResultValue <> 0 Then MsgBox "Failed to get the file common info." End If Dim Count As Long Count = FileCommonInfoSet.GetCount Dim Index As Long For Index = 0 To Count - 1 FileCommonInfoSet.Get Index, FileCommonInfo Dim CheckinDateTime As Date CheckinDateTime = FileCommonInfo.CheckinDateTime Dim CheckoutUser As String CheckoutUser = FileCommonInfo.CheckoutUser Dim Description As String Description = FileCommonInfo.Description Dim FileLengthLow As Long FileLengthLow = FileCommonInfo.FileLengthLow Dim FileLengthHigh As Long FileLengthHigh = FileCommonInfo.FileLengthHigh Dim FileName As String FileName = FileCommonInfo.FileName Dim IsMergeable As Boolean IsMergeable = FileCommonInfo.IsMergable Dim ItemStatus As Enum_ItemStatus ItemStatus = FileCommonInfo.ItemStatus Dim ModificationDateTime As Date ModificationDateTime = FileCommonInfo.ModificationDateTime Dim IsSuccessful As Boolean IsSuccessful = FileCommonInfo.Successful Dim VersionNumberLow As Long VersionNumberLow = FileCommonInfo.VersionNumberLow Dim VersionNumberHigh As Long VersionNumberHigh = FileCommonInfo.VersionNumberHigh Next End Sub |