Click or drag to resize

wclGattClientWriteClientConfiguration Method

Writes the client configuration descriptor to the device.

Namespace: wclBluetooth
Assembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.17.12.0 (7.17.12.0)
Syntax
Copy
public int WriteClientConfiguration(
	wclGattCharacteristic Characteristic,
	bool Subscribe,
	wclGattOperationFlag Flag,
	wclGattProtectionLevel Protection = wclGattProtectionLevel.plNone,
	wclGattSubscribeKind SubscribeKind = wclGattSubscribeKind.skManual
)

Parameters

Characteristic  wclGattCharacteristic
A characteristic object in that changes an application is interested.
Subscribe  Boolean
The value indicates should we subscribe or unsubscribe from the characteristic value changes.
Flag  wclGattOperationFlag
Operation behavior flag.
Protection  wclGattProtectionLevel  (Optional)
Describes the required protection level.
SubscribeKind  wclGattSubscribeKind  (Optional)
Indicates a characteristic value change notification method that should be used. If a characteristic has both IsIndicatable and IsNotifiable properties set then this parameter allows to control which notification method should be used.

Return Value

Int32
If the function succeed the return value is WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.
Remarks
In order to receive notifications about characteristic value changes the client must set the Client Configuration Descriptor. An application can use this method to do it in easy way.
See Also