wclGattClientUnsubscribeFromNotifications Method |
Unsubscribes from the characteristic changes
notifications and writes the client configuration descriptor to the
device.
Namespace: wclBluetoothAssembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.17.12.0 (7.17.12.0)
Syntax public int UnsubscribeFromNotifications(
wclGattCharacteristic Characteristic,
wclGattOperationFlag Flag = wclGattOperationFlag.goNone,
wclGattProtectionLevel Protection = wclGattProtectionLevel.plNone,
wclGattSubscribeKind SubscribeKind = wclGattSubscribeKind.skManual
)
Public Function UnsubscribeFromNotifications (
Characteristic As wclGattCharacteristic,
Optional Flag As wclGattOperationFlag = wclGattOperationFlag.goNone,
Optional Protection As wclGattProtectionLevel = wclGattProtectionLevel.plNone,
Optional SubscribeKind As wclGattSubscribeKind = wclGattSubscribeKind.skManual
) As Integer
public:
int UnsubscribeFromNotifications(
wclGattCharacteristic Characteristic,
wclGattOperationFlag Flag = wclGattOperationFlag::goNone,
wclGattProtectionLevel Protection = wclGattProtectionLevel::plNone,
wclGattSubscribeKind SubscribeKind = wclGattSubscribeKind::skManual
)
Parameters
- Characteristic wclGattCharacteristic
- A characteristic object in that changes
an application is interested.
- Flag wclGattOperationFlag (Optional)
- 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 You can use this method to replace calls to the
Unsubscribe and to the WriteClientConfiguration
methods.
See Also