BTH_LE_GATT_DESCRIPTOR_VALUE structure (bthledef.h)
The BTH_LE_GATT_DESCRIPTOR_VALUE structure describes a parent characteristic.
Syntax
typedef struct _BTH_LE_GATT_DESCRIPTOR_VALUE {
BTH_LE_GATT_DESCRIPTOR_TYPE DescriptorType;
BTH_LE_UUID DescriptorUuid;
union {
struct {
BOOLEAN IsReliableWriteEnabled;
BOOLEAN IsAuxiliariesWritable;
} CharacteristicExtendedProperties;
struct {
BOOLEAN IsSubscribeToNotification;
BOOLEAN IsSubscribeToIndication;
} ClientCharacteristicConfiguration;
struct {
BOOLEAN IsBroadcast;
} ServerCharacteristicConfiguration;
struct {
UCHAR Format;
UCHAR Exponent;
BTH_LE_UUID Unit;
UCHAR NameSpace;
BTH_LE_UUID Description;
} CharacteristicFormat;
};
ULONG DataSize;
#if ...
UCHAR *Data[];
#else
UCHAR Data[1];
#endif
} BTH_LE_GATT_DESCRIPTOR_VALUE, *PBTH_LE_GATT_DESCRIPTOR_VALUE;
Members
DescriptorType
The type of the descriptor value.
DescriptorUuid
The Universally Unique ID (UUID) of the descriptor value.
CharacteristicExtendedProperties
Container structure for the different characteristic extended property members.
CharacteristicExtendedProperties.IsReliableWriteEnabled
The parent characteristic value is reliable write enabled.
CharacteristicExtendedProperties.IsAuxiliariesWritable
The characteristic user description descriptor is writable.
ClientCharacteristicConfiguration
Container structure for the different client characteristic configuration members.
ClientCharacteristicConfiguration.IsSubscribeToNotification
Whether the characteristic has been registered with the device to receive Handle Value Notifications. TRUE if the characteristic has been registered. Otherwise, FALSE.
ClientCharacteristicConfiguration.IsSubscribeToIndication
Whether the characteristic has been registered with the device to receive Handle Value Indications. TRUE if the characteristic has been registered. Otherwise, FALSE.
ServerCharacteristicConfiguration
Container structure for the different server characteristic configuration members.
ServerCharacteristicConfiguration.IsBroadcast
The parent characteristic value can be broadcast.
CharacteristicFormat
Container structure for the different characteristic format members.
CharacteristicFormat.Format
The format of the parent characteristic value.
CharacteristicFormat.Exponent
The exponent value to use to determine how the value of the characteristic value is further formatted.
CharacteristicFormat.Unit
The unit of the characteristic value as defined in the Assigned Numbers specification.
CharacteristicFormat.NameSpace
The name-space where the unit is defined in the Assigned Numbers specification.
CharacteristicFormat.Description
The Universally Unique ID (UUID) that describes the format of the parent characteristic value.
DataSize
The size, in bytes, of the descriptor value.
Data[*]
A pointer to the descriptor value data.
Data[1]
A pointer to the descriptor value data.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Versions:_Supported in Windows 8 |
| Header | bthledef.h (include BthLEDef.h) |