Function ziAPIModSetIntegerData#

ZIResult_enum ziAPIModSetIntegerData(ZIConnection conn, ZIModuleHandle handle, const char *path, ZIIntegerData value)#

Sets a module parameter to the specified integer type.

This function is used to configure (set) module parameters which have integer 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.

  • value[in] The integer data to write to the path.

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.