DriveState Property

The state of the drive space.

Syntax

 onedrive.getDriveState([callback])

Possible Values

  0 (qsNormal), 
  1 (qsNearing), 
  2 (qsCritical), 
  3 (qsExceeded)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getDriveState([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setDriveState([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property holds the state of the drive space. This provides a way to easily determine when a drive is running out of space. Possible values are:

This property is read-only and not available at design time.

Data Type

Integer