GetVolumeLabel Event

Fires when the OS needs the volume label.

Syntax

virtual int FireGetVolumeLabel(CBFSGetVolumeLabelEventParams *e);
typedef struct {
char *Buffer; int lenBuffer;
int ResultCode; int reserved; } CBFSGetVolumeLabelEventParams;
virtual INT FireGetVolumeLabel(CBFSGetVolumeLabelEventParams *e);
typedef struct {
LPWSTR Buffer; INT lenBuffer;
INT ResultCode; INT reserved; } CBFSGetVolumeLabelEventParams;

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. Note that the volume label must be copied to Buffer; set lenBuffer to the length of the copied string (measured in char/wchar_t, not including terminating nulls).

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.

 
 
Copyright (c) 2020 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 C++ Edition - Version 20.0 [Build 7545]