Function ziAPISetValueString#

ZIResult_enum ziAPISetValueString(ZIConnection conn, const char *path, const char *str)#

asynchronously sets a string value of one or more nodes specified in the path

This function sets the values at the nodes specified in a path. More than one value can be set if a wildcard is used. The function sets the value asynchronously which means that after the function returns you have no security to which value it is finally set nor at what point in time it is set.

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

  • str[in] Pointer to a null terminated string (max 64k characters)

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_WARNING_INVALID_KEYWORD if the given keyword could not be resolved

  • ZI_ERROR_TIMEOUT when communication timed out.

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