Function ziAPIModFinished#

ZIResult_enum ziAPIModFinished(ZIConnection conn, ZIModuleHandle handle, ZIIntegerData *finished)#

Queries whether the module has finished its measurement task.

This function can be used to query whether the module has finished its task or not.

See also

ziAPIModExecute, ziAPIModFinish, ziAPIModProgress

Parameters:

  • conn – [in] The ZIConnection from which the module was created.

  • handle – [in] The ZIModuleHandle specifying the module to execute.

  • finished – [out] A pointer to ZIIntegerData, upon return this will be 0 if the module is still executing or 1 if it has finished executing.

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.