Function GenieDialog_bindEngine

Function Documentation

Genie_Status_t GenieDialog_bindEngine(const GenieDialog_Handle_t dialogHandle, const char *engineType, const GenieEngine_Handle_t engineHandle)

A function to bind engine handle to dialog.

Parameters

  • dialogHandle – [in] A dialog Handle

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

  • engineHandle – [in] The engine handle. Cannot be NULL.

Returns

Status code:

  • GENIE_STATUS_SUCCESS: API call was successful.

  • GENIE_STATUS_ERROR_INVALID_HANDLE: dialog handle or engine handle is invalid.

  • GENIE_STATUS_ERROR_INVALID_ARGUMENT: invalid engineType.

Note

It will unload the active engine (defined by engineType) of the dialog, if it is not retrieved by GenieDialog_getEngine API.

Note

Only draft engine binding is supported.