BACnetStack_SendAtomicWriteFile

bool BACnetStack_SendAtomicWriteFile(
  uint8_t * sentInvokeId,
  const uint32_t fileInstance,
  const uint8_t fileAccessMethod,
  const int32_t fileStart,
  const uint8_t * fileData,
  const uint32_t fileDataLength,
  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 AtomicWriteFile request to write a range of data to a remote File object.

Note

Requires one of the build options STACK_OPTION_NM_SCCM_A (with the BACnet/SC data link), STACK_OPTION_DM_BR_BACKUP_AND_RESTORE (any of them turns on STACK_OPTION_ATOMIC_FILE_IO, the macro this function checks).

See also: Client response hooks

BACnet reference: ANSI/ASHRAE 135-2024 clause 14.2 (AtomicWriteFile Service).

Parameters

Parameter	Direction	Description
sentInvokeId	out	The invoke-id of the sent request, valid only if this function returns true.
fileInstance	in	The instance of the remote File object to write.
fileAccessMethod	in	The access-method CHOICE tag of the AtomicWriteFile service request: 0 = Stream Access, 1 = Record Access (ASHRAE 135-2024 cl. 21, AtomicWriteFile-Request). GOTCHA: the INVERSE of the BACnetFileAccessMethod ENUMERATED on the File object’s File_Access_Method property, which is { record-access (0), stream-access (1) }. This parameter is the SERVICE tag, not the property value.
fileStart	in	The starting octet to write to. Pass -1 to append to the end of the file (ASHRAE 135-2024 cl. 14.2.2.2.1 for Stream Access, 14.2.2.3.1 for Record Access). It is signed, as on BACnetStack_SendAtomicReadFile(), but only the write form gives -1 this meaning.
fileData, fileDataLength	in	The data to write and its length in bytes.
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.