Function ziAPIModSetByteArray#

ZIResult_enum ziAPIModSetByteArray(ZIConnection conn, ZIModuleHandle handle, const char *path, uint8_t *buffer, uint32_t length)#

Sets a module parameter to the specified byte array.

This function is used to configure (set) module parameters which have byte array types.

Parameters:
  • conn[in] The ZIConnection from which the module was created.

  • handle[in] The ZIModuleHandle specifying the module to set data on.

  • path[in] Path of the module parameter to set.

  • buffer[in] Pointer to the byte array with the data.

  • length[in] Length of the data in the buffer.

Returns:

  • ZI_INFO_SUCCESS On success.

  • ZI_ERROR_CONNECTION When the connection is invalid (not connected) or when a communication error occurred.

  • ZI_ERROR_GENERAL If a general error occurred, use ziAPIGetLastError for a detailed error message.

  • Other return codes may also be returned, for a detailed error message use ziAPIGetLastError.