GetInformation

SpaceObServer.Application.GetInformation

Description

Query file system information about the scanned directory with the passed ID.

Syntax

GetInformation (FolderID : <Integer>, InfoType : <String>, UsePlainValues : <Boolean>, [out]NodeData : <OLEVariant>)

Parameters

FolderID

The ID referring to the folder, from which data should be extracted. You get this ID from the functions RootFolderID, FirstChildID or NextSiblingID.

InfoType

Defines the kind of requested information about a directory. The table of the Directory tree / Details List values lists all accessible information.

UsePlainValues

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

[out]NodeData

(Out Parameter) The delivered data. This is the place, to define a storing place for the returned data, you wanted to get.

Example

PowerShell:

$RootFolderID = $SOS.RootFolderID
$SOS.GetInformation($RootFolderID, "Size", $False, $OutParameter)

VBS:

RootFolderID = SOS.RootFolderID
SOS.GetInformation RootFolderID, "Size", False, OutParameter

The call of GetInformation() gathers the size of the current root directory, and returns it in a OLEVariant variable called “OutParameter”. “OutParameter” can be accessed like every other variable of the variant type, and it’s content can be used for printing.

Remarks

This function will query the latest scan information about a scanned directory. To get information from earlier scans, please use GetHistoricalInformation.