alf_task_desc

NAME

alf_task_desc_destroy - Destroys the specified task descriptor and frees up the resources associated with this task descriptor.

SYNOPSIS

int alf_task_desc_destroy (alf_task_desc_handle_t task_desc_handle);

Parameters
`task_desc_handle [IN/OUT]`	Handle to a task descriptor. This data structure is destroyed when it returns from this call.

DESCRIPTION

This function destroys the specified task descriptor and frees up the resources associated with this task descriptor. A task descriptor cannot be destroyed if it is being used by a task. An attempt to destroy an occupied task descriptor results in an error.

RETURN VALUE

0	Successful
less than 0	Errors occurred: `ALF_ERR_INVAL`: Invalid input argument. `ALF_ERR_BADF`: Invalid task descriptor handle. `ALF_ERR_BUSY`: This task descriptor is being used. You must destroy all tasks using this descriptor before you can destroy the descriptor. `ALF_ERR_PERM`: The API call is not permitted at the current context. `ALF_ERR_GENERIC`: Generic internal errors.