GetListInformation

SpaceObServer.Application.GetListInformation

Description

Query information about a specific file or folder in a specific list.

Syntax

GetListInformation (ID : <Integer>, ListType : <String>, InfoType : <String>, UsePlainValues : <String>)

Parameters

ID

The ID referring to the file or folder, from which data should be extracted. You get this ID from the functions GetFirstListID, GetNextSiblingListID or GetFirstChildListID.

ListType

Defines the type of list from which the information should be queried. The table of the Export Statistics values lists all accessible list types. Note: “ConfigureScans” is supported.

InfoType

Defines the kind of requested information about a directory. The table of the Information Types values lists all accessible information.

UsePlainValues

Indicates, if size units and thousand separator will be included in the result, or if sizes are returned as plain values. Note: The property Decimals is still taken into account. In order to plain integer values you have to set Decimals to 0 before.

Return Value

The queried information for the given object ID in the given list.

Example

PowerShell:

$ID = $SOS.GetFirstListID("DetailsList")
$SOS.GetListInformation($ID, "DetailsList", "Size", $true)

VBS:

ID = SOS.GetFirstListID "DetailsList"
SOS.GetListInformation ID, "DetailsList", "Size", true

The call of GetListInformation() gathers the size of the given ID in the Details List and returns it as OLEVariant.

Remarks

The available information types depend on the parameter ListType.