Get Volume Information Action

Declaration

<AMGETDRIVEINFO DRIVE="text [options]" DRIVENAME="text" DRIVEINFO="text [options]" RESULTVARIABLE="text [variable name]" RESULTDATASET="text [dataset name]" />

See Also

Get Volume Information Action-Setting Properties, Get Process Information Action, Run Action, Log Event Action

Description

Returns specific information about a drive (volume type, volume label, user quota, capacity, available space, used space) and populates an AutoMate variable with the result, or creates and populates a dataset that contains all parameters about all drives on the system. Volume sizes are expressed in KB.

Practical Usage

Used to retrieve system drive data (see Description).

Parameters

General Tab

Specific Drive Information/Create Dataset for all Volumes

Text, Optional - Default "SINGLE"
MARKUP: DRIVE="ALL"

Specifies whether to get one or all volumes.  

The available options are:

Single--This will get one volume's specific information into Automate Variable.

All--This will get all volume's all information into Automate Dataset.

Drive

Text, Optional - Default "C:\"
MARKUP: DRIVENAME="C:\"

Specifies the drive from which to get data. Valid only if DRIVE parameter is "Single."

Parameter

Text, Optional - Default: volume type
MARKUP: DRIVEINFO="VOLUMELABEL"

Specifies the type of information with which to populate the variable. Valid only if DRIVE parameter is "Single."

The available options are:
 

Populate Variable With Result

Text [Variable Name], Required
MARKUP: RESULTVARIABLE="VariableName"

Specifies the name of an already created variable to be populated with the specified drive data. Valid only if DRIVE parameter is "Single."

Dataset to Populate With All Information

Text [Dataset Name], Required
MARKUP: RESULTDATASET="VolumeInfoDataset"

Specifies the name of an AutoMate dataset to be created and populated with the drive data. Valid only if DRIVE parameter is "All."

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Examples

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMGETDRIVEINFO DRIVE="SINGLE" DRIVENAME="C:\" DRIVEINFO="VOLUMELABEL" RESULTVARIABLE="VariableName" />

<AMGETDRIVEINFO DRIVE="ALL" RESULTDATASET="VolumeInfoDataset" />