Function GenieNode_getEngine

Function Documentation

Genie_Status_t GenieNode_getEngine(const GenieNode_Handle_t nodeHandle, const char *engineType, GenieEngine_Handle_t *nodeEngineHandle)

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

Parameters

  • nodeHandle – [in] A node handle.

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

  • nodeEngineHandle – [in] A engine handle tied to nodeHandle. Must not be NULL.

Returns

Status code:

  • GENIE_STATUS_SUCCESS: API call was successful.

  • GENIE_STATUS_ERROR_INVALID_HANDLE: Node 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 GenieNode_getEngine API increases the engine’s reference count. The engine is freed only when reference count reaches zero either with GenieNode_free or GenieEngine_free.