PathSeparator Property

The path separator character to use when returning vault paths.

Syntax

 cbdrive.getPathSeparator([callback])
 cbdrive.setPathSeparator( pathSeparator, [callback])

Default Value

92

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 getPathSeparator([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 setPathSeparator([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 path separator character that the class APIs should use when returning a vault path. Valid values are:

Note that this property is just a convenience; applications are free to use either of the above characters as path separators when passing path strings to the class's APIs.

Note: This property cannot be changed when Active is true, and cannot be changed within events.

Data Type

Integer