MaxFileNameLength Property

The maximum filename length supported by the virtual filesystem.

Syntax

 cbfs.getMaxFileNameLength([callback])
 cbfs.setMaxFileNameLength( maxFileNameLength, [callback])

Default Value

260

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 getMaxFileNameLength([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 setMaxFileNameLength([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 virtual filesystem's maximum supported filename length, measured in characters. Setting this property to a value less than its default of 260 characters, which corresponds to Windows' MAX_PATH constant, is not recommended.

Note: This property cannot be changed after a virtual drive is created, and cannot be changed within events.

Data Type

Integer