GetVolumeLabel Event

Fires when the OS needs the volume label.

Syntax

cbfs.on('GetVolumeLabel', [callback])

Callback

The 'callback' is called when the 'GetVolumeLabel' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.buffer
e.resultCode

Remarks

This event fires anytime the OS needs to retrieve the volume label of the virtual drive.

To handle this event properly, applications must set Buffer to the most recent value obtained via SetVolumeLabel.

The length of the returned volume label must not exceed 32 characters, which is the maximum length supported by the OS.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.