CBFS Connect 2020 .NET Edition

Questions / Feedback?

GetVolumeObjectId Event

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

Syntax

public event OnGetVolumeObjectIdHandler OnGetVolumeObjectId;

public delegate void OnGetVolumeObjectIdHandler(object sender, CbfsGetVolumeObjectIdEventArgs e);

public class CbfsGetVolumeObjectIdEventArgs : EventArgs {
  public IntPtr ObjectId { get; }
  public int ObjectIdLength { get; }
  public IntPtr ExtendedInformation { get; }
  public int ExtendedInformationLength { get; }
  public int ResultCode { get; set; }
}
Public Event OnGetVolumeObjectId As OnGetVolumeObjectIdHandler

Public Delegate Sub OnGetVolumeObjectIdHandler(sender As Object, e As CbfsGetVolumeObjectIdEventArgs)

Public Class CbfsGetVolumeObjectIdEventArgs Inherits EventArgs
  Public ReadOnly Property ObjectId As IntPtr
  Public ReadOnly Property ObjectIdLength As Integer
  Public ReadOnly Property ExtendedInformation As IntPtr
  Public ReadOnly Property ExtendedInformationLength As Integer
  Public Property ResultCode As Integer
End Class

Remarks

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