SetVolumeLabel Event

Fires when the OS wants to change the volume label.

Syntax

ANSI (Cross Platform)
virtual int FireSetVolumeLabel(CBFSSetVolumeLabelEventParams *e);
typedef struct {
const char *VolumeLabel;
int ResultCode; int reserved; } CBFSSetVolumeLabelEventParams; Unicode (Windows) virtual INT FireSetVolumeLabel(CBFSSetVolumeLabelEventParams *e);
typedef struct {
LPCWSTR VolumeLabel;
INT ResultCode; INT reserved; } CBFSSetVolumeLabelEventParams;
#define EID_CBFS_SETVOLUMELABEL 46

virtual INT CBFSCONNECT_CALL FireSetVolumeLabel(LPWSTR &lpszVolumeLabel, INT &iResultCode);

Remarks

This event fires when the OS wants to change the volume label of the virtual drive.

To handle this event properly, applications must store the new volume label specified by VolumeLabel.

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) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 C++ Edition - Version 20.0 [Build 8348]