Function ziAPIModGetVector#

ZIResult_enum ziAPIModGetVector(ZIConnection conn, ZIModuleHandle handle, const char *path, void *buffer, unsigned int *bufferSize, ZIVectorElementType_enum *elementType, unsigned int *numElements)#

Gets the vector stored at the specified module parameter path.

This function is used to retrieve module parameter values of type vector.

See also

ziAPIModGetInteger, ziApiModGetDouble, ziAPIModGetString

Parameters:

  • conn – [in] Pointer to the ziConnection with which the value should be retrieved.

  • handle – [in] The ZIModuleHandle specifying the module to get the value from.

  • path – [in] The path of the module parameter to get data from.

  • buffer – [out] Pointer to a buffer to store the retrieved vector buffer.

  • bufferSize – [inout] Pointer to an unsigned int indicating the length of the buffer. If the length of the passed buffer is insufficient to store the vector, the value is modified to indicate the required minimum buffer size and ZI_ERROR_LENGTH is returned.

  • elementType – [out] Pointer to store the type of vector elements.

  • numElements – [out] Pointer to an unsigned int to store the number of elements of the vector. If the length of the passed buffer is insufficient, a zero will be returned.

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 vector’s length exceeds the buffer size

  • ZI_ERROR_COMMAND on an incorrect answer of the server

  • ZI_ERROR_SERVER_INTERNAL if an internal error occurred in Data Server

  • ZI_WARNING_NOTFOUND if the given path could not be resolved or no value is attached to the path

  • ZI_ERROR_TIMEOUT when communication timed out

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