BACnetStack_SendReadRangeWithPosition
bool BACnetStack_SendReadRangeWithPosition( uint8_t * sentInvokeId, const uint16_t objectType, const uint32_t objectInstance, const uint32_t propertyIdentifier, const bool usePropertyArrayIndex, const uint32_t propertyArrayIndex, const uint32_t referenceIndex, const int16_t count, 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 ReadRange request using the By Position reference (cl. 15.8), reading count entries starting at referenceIndex (negative count reads backwards from the reference).
The reference is sent as the by-position [3] arm of the request’s range CHOICE (cl. 21).
See also: Client response hooks
BACnet reference: ANSI/ASHRAE 135-2024 clause 15.8 (ReadRange Service).
Parameters
Section titled “Parameters”| Parameter | Direction | Description |
|---|---|---|
sentInvokeId |
out | The invoke-id of the sent request, valid only if this function returns true. |
objectType, objectInstance |
in | The object being queried: one BACnet Object Identifier, carried as two parameters (see the API conventions). |
propertyIdentifier |
in | The list/array property to read a range of. |
usePropertyArrayIndex, propertyArrayIndex |
in | If usePropertyArrayIndex is true, read a range of this array element. |
referenceIndex |
in | The 1-based list/array index to read relative to. |
count |
in | The number of entries to read; negative reads backwards from referenceIndex. 0 is refused (135-2024 cl. 15.8.1.1.4.1.2): the function returns false and sends nothing. |
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
Section titled “Returns”True if the request was sent, otherwise false.
Topic: Client requests. Declared in CASBACnetStackDLL.h.