Function ziAPIModSetVector#

ZIResult_enum ziAPIModSetVector(ZIConnection conn, ZIModuleHandle handle, const char *path, const void *vectorData, ZIVectorElementType_enum elementType, unsigned int numElements)#

Sets a module parameter to the specified vector.

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

See also

ziAPIModSetDoubleData, ziAPIModSetIntegerData, ziAPIModSetByteArray

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.

  • vectorData – [in] Pointer to the vector data.

  • elementType – [in] Type of elements stored in the vector.

  • numElements – [in] Number of elements of the vector.

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.