Edit

_BRB_GET_DEVICE_INTERFACE_STRING structure (bthddi.h)

  • Article

The _BRB_GET_DEVICE_INTERFACE_STRING structure describes the device interface string for the current device object.

Syntax

struct _BRB_GET_DEVICE_INTERFACE_STRING {
  BRB_HEADER Hdr;
  PWCHAR     DeviceInterfaceString;
  ULONG      DeviceInterfaceStringCbLength;
};

Members

Hdr

A BRB_HEADER structure that contains information about the current BRB.

DeviceInterfaceString

A pointer to the buffer to contain the device interface string.

DeviceInterfaceStringCbLength

On input, this member specifies the length, in bytes, of the device interface string. On output, this member specifies the number of bytes required for the string if the BRB_GET_DEVICE_INTERFACE_STRING BRB fails and returns STATUS_MORE_ENTRIES because of insufficient buffer length. If the BRB call succeeds, this member contains the number of bytes copied.

Remarks

To get the device interface string for the current device object, profile drivers should build and send a BRB_GET_DEVICE_INTERFACE_STRING request.

The Bluetooth driver stack performs an IoRegisterDeviceInterface call on each device object it creates. The BRB returns the device interface string returned by that call. This can be useful for registering for events.

If the buffer pointed to by the DeviceInterfaceString member is not large enough to hold the string, the call fails and the DeviceInterfaceStringCbLength member contains the required buffer length.

Requirements

Requirement Value
Minimum supported client Versions:_Supported in Windows Vista, and later.
Header bthddi.h (include Bthddi.h)

See also

BRB_GET_DEVICE_INTERFACE_STRING

BRB_HEADER

IoRegisterDeviceInterface