Function GenieDialog_getEngine

• Defined in File GenieDialog.h

Function Documentation

Genie_Status_t GenieDialog_getEngine(const GenieDialog_Handle_t dialogHandle, const char *engineType, GenieEngine_Handle_t *dialogEngineHandle)

A function to get the engine handle associated with a dialog.

Parameters

• dialogHandle – [in] A dialog handle.

• engineType – [in] type of the engine i.e., target or draft.

• dialogEngineHandle – [in] A engine handle tied to dialogHandle. Must not be NULL.

Returns

Status code:

• GENIE_STATUS_SUCCESS: API call was successful.

• GENIE_STATUS_ERROR_INVALID_HANDLE: Dialog handle is invalid.

• GENIE_STATUS_ERROR_INVALID_ARGUMENT: At least one argument is invalid.

• GENIE_STATUS_ERROR_GET_HANDLE_FAILED: Get engine handle failure.

Note

Each call to GenieDialog_getEngine API increases the engine’s reference count. The engine is freed only when reference count reaches zero either with GenieDialog_free or GenieEngine_free.