GetVolumeObjectId Event

Fires when the OS needs the volume object Id and extended information.


virtual int FireGetVolumeObjectId(CBFSGetVolumeObjectIdEventParams *e);
typedef struct {
void *ObjectId;
int ObjectIdLength;
void *ExtendedInformation;
int ExtendedInformationLength;
int ResultCode; int reserved; } CBFSGetVolumeObjectIdEventParams;
virtual INT FireGetVolumeObjectId(CBFSGetVolumeObjectIdEventParams *e);
typedef struct {
LPVOID ObjectId;
INT ObjectIdLength;
LPVOID ExtendedInformation;
INT ExtendedInformationLength;
INT ResultCode; INT reserved; } CBFSGetVolumeObjectIdEventParams;


This event fires anytime the OS needs to retrieve the volume object Id and extended information for the virtual drive.

To handle this event properly, applications must populate the ObjectId and ExtendedInformation buffers with the most recent values obtained via SetVolumeObjectId.

The ObjectIdLength and ExtendedInformationLength values are specified by the OS; they will always be 16 and 48 bytes, respectively.

Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

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]