The BluetoothGATTGetIncludedServices function gets all the included services available for a given service.
HRESULT BluetoothGATTGetIncludedServices( HANDLE hDevice, PBTH_LE_GATT_SERVICE ParentService, USHORT IncludedServicesBufferCount, PBTH_LE_GATT_SERVICE IncludedServicesBuffer, USHORT *IncludedServicesBufferActual, ULONG Flags );
Handle to the Bluetooth device or parent service.
Address of a BTH_LE_GATT_SERVICE structure that contains the parent service of the included services to be retrieved. This parameter is required if a device handle is passed to hDevice. This parameter is optional if a service handle was passed to hDevice, in which case the service specified by the service handle will be treated as the parent.
The number of elements allocated for the IncludedServicesBuffer parameter.
Address of a buffer containing a BTH_LE_GATT_SERVICE structure into which to return included services.
Pointer to buffer into which the actual number of included services were returned in the IncludedServicesBuffer parameter.
Flags to modify the behavior of BluetoothGATTGetIncludedServices:
|BLUETOOTH_GATT_FLAG_NONE||The client does not have specific GATT requirements (default).|
This function returns the following values:
||The operation completed successfully.|
||The buffer parameter is NULL and the number of items available is being returned instead.|
||Returned if both a parent service and a service handle are provided and the service hierarchy does not roll up to the provided parent service handle.|
One of the following conditions occurred:
||A buffer is specified, but the buffer count size is smaller than what is required, in bytes.|
||Services were specified to be retrieved from the cache, but no services are present in the cache.|
||The current data in the cache appears to be inconsistent, and is leading to internal errors.|
||The operation ran out of memory.|
Returned services are cached upon successful retrieval of services from the device directly. Unless a service-change event is received, the list of returned services is not expected to change.
Profile drivers should pre-allocate a sufficiently large buffer for the array of primary services to be returned in. Callers can determine the necessary buffer size by passing a non-NULL value in IncludedServicesBufferActual and NULL in IncludedServicesBuffer.
Do not modify the returned service structure, and then use the modified structure in subsequent function calls. Behavior is undefined if the caller does this.
//////////////////////////////////////////////////////////////////////////// // Determine Included Services Buffer Size //////////////////////////////////////////////////////////////////////////// hr = BluetoothGATTGetIncludedServices( hLEDevice, gattService, 0, NULL, &inclServicesBufferSize, BLUETOOTH_GATT_FLAG_NONE);
|Windows version||Supported in Windows 8 and later versions of Windows.|