BACnetStack_SendCancelSubscribeCOVProperty

bool BACnetStack_SendCancelSubscribeCOVProperty(
  uint8_t * sentInvokeId,
  const uint32_t subscriberProcessIdentifier,
  const uint16_t monitoredObjectType,
  const uint32_t monitoredObjectInstance,
  const uint32_t monitoredPropertyIdentifier,
  const bool usePropertyArrayIndex,
  const uint32_t propertyArrayIndex,
  const uint8_t * connectionString,
  const uint8_t connectionStringLength,
  const uint32_t networkPortInstance,
  const uint16_t destinationNetwork,
  const uint8_t * destinationAddress,
  const uint8_t destinationAddressLength);

Sends a confirmed SubscribeCOVProperty request with no issueConfirmedNotifications/lifetime (a cancellation), ending a previously established per-property COV subscription.

Note

Requires the STACK_OPTION_DS_COVP_SUBSCRIBE_COV_PROPERTY (with STACK_OPTION_DS_COV_SUBSCRIBE_COV) build option (it turns on STACK_OPTION_SUBSCRIBE_COV_PROPERTY, the macro this function checks).

See also: Client response hooks

BACnet reference: ANSI/ASHRAE 135-2024 clause 13.15 (SubscribeCOVProperty Service).

Parameters

Parameter	Direction	Description
sentInvokeId	out	The invoke-id of the sent request, valid only if this function returns true.
subscriberProcessIdentifier	in	The process identifier of the subscription to cancel.
monitoredObjectType, monitoredObjectInstance	in	The object the subscription was made against. The type and instance are one BACnet Object Identifier carried as two parameters (see the API conventions).
monitoredPropertyIdentifier	in	The property the subscription was made against.
usePropertyArrayIndex, propertyArrayIndex	in	If usePropertyArrayIndex is true, the array element the subscription was made against. monitoredPropertyIdentifier and this optional array index are sent together as the request’s one BACnetPropertyReference (cl. 21).
connectionString, connectionStringLength	in	The datalink address to send TO (the destination) - not the local address to send from. For IPv4 this is 6 bytes: 4 octets of IPv4 address followed by 2 octets of port, big-endian (e.g. 0xC0,0xA8,0x01,0x05,0xBA,0xC0 = 192.168.1.5:47808; see BACnetStack_SendRegisterForeignDevice() for a worked example); on BACnet/IPv4 the stack refuses to send to a connection string of any other length, except that a broadcast from a device registered as a foreign device goes to its BBMD and does not use the connection string. MS/TP and BACnet/SC use a different connection-string shape; see their respective Set/Send exports.
networkPortInstance	in	The Network Port object instance to send the message on, or BACNET_NETWORK_PORT_DEFAULT (4194303) for the default/single port.
destinationNetwork, destinationAddress, destinationAddressLength	in	The destination to send the request to.

Returns

True if the request was sent, otherwise false.

Topic: Client requests. Declared in CASBACnetStackDLL.h.