DriveIndex Property

Selects a drive.

Syntax

 onedrive.getDriveIndex([callback])
 onedrive.setDriveIndex( driveIndex, [callback])

Default Value

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 getDriveIndex([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 setDriveIndex([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 specifies the drive after calling ListDrives. Valid values are from 0 to DriveCount -1. After setting this property the following properties are populated:

This property is not available at design time.

Data Type

Integer