SpaceObServer.Application.GetHistoricalInformation

<< Click to Display Table of Contents >>

Navigation:  OLE Automation > Application > Methods >

SpaceObServer.Application.GetHistoricalInformation

Description

Query file system information about the scanned directory with the passed ID for an earlier scan.
 

Syntax

GetHistoricalInformation (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 Information Type 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.

Date

The scan date we want to get the information for.
Please use the ISO date format> "YYYY-MM-DD".

[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.GetHistoricalInformation($RootFolderID, "Size", $False, "2010-08-01", $OutParameter)

VBS:

RootFolderID = SOS.RootFolderID
SOS.GetHistoricalInformation RootFolderID, "Size", False, "2010-08-01", OutParameter

The call of GetHistoricalInformation() gathers the size  of the current root directory at the given date (1st August 2010), 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 information about a scanned directory for any earlier scan date. To get information from the last scan, please use GetInformation().