Function ziAPISyncSetValueI#

ZIResult_enum ziAPISyncSetValueI(ZIConnection conn, const char *path, ZIIntegerData *value)#

synchronously sets an integer-type value to one or more nodes specified in a path

This function sets the values of the nodes specified in path to value. More than one value can be set if a wildcard is used. The function sets the value synchronously. After returning you know that it is set and to which value it is set.

See also

ziAPIGetValueI, ziAPISetValueI

Parameters:

  • conn – [in] Pointer to the ziConnection for which the value(s) will be set

  • path – [in] Path to the node(s) for which the value(s) will be set

  • value – [in] Pointer to a int-type containing then value to be written. when the function returns value holds the effectively written value.

Returns:

  • ZI_INFO_SUCCESS on success

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

  • ZI_ERROR_LENGTH if the Path’s Length exceeds MAX_PATH_LEN

  • ZI_ERROR_READONLY on attempt to set a read-only node

  • ZI_ERROR_COMMAND on an incorrect answer of the server

  • ZI_ERROR_SERVER_INTERNAL if an internal error occurred in the Data Server

  • ZI_WARNING_NOTFOUND if the given path could not be resolved or no node given by path is able to hold values

  • ZI_ERROR_TIMEOUT when communication timed out

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