alf_task_finalize

NAME

alf_task_finalize - Finalizes the work block queue of the specified task.

SYNOPSIS

int alf_task_finalize (alf_task_handle_t task_handle)

Parameters
`task_handle [IN]`	The task handle that is returned by the `alf_create_task` API

DESCRIPTION

This function finalizes the task. After the task has been finalized, future calls to alf_wb_create and alf_task_depends_on and alf_task_event_handler_register return errors.

Note: Task finalization is a compulsory condition for a task to run and complete normally.

RETURN VALUE

less than 0

Errors occurred:

ALF_ERR_BADF: Invalid task descriptor handle.
ALF_ERR_SRCH: Already finalized task handle.
ALF_ERR_PERM: The API call is not permitted at the current context. For example, some created work block handles are not enqueued.
ALF_ERR_GENERIC: Generic internal errors.