alf_dataset_destroy

NAME

alf_dataset_destroy - Destroys a given data set.

SYNOPSIS

int alf_dataset_destroy(alf_dataset_handle_t dataset_handle);

Parameters  
dataset_handle Handle to the dataset

DESCRIPTION

This function destroys a given dataset. Further references to the dataset result in indeterminate behaviors. Further references to the data within a dataset are still valid. You cannot destroy a dataset if there are still running tasks associated with a dataset.

RETURN VALUE

0 Success
less than 0 Errors occurred:
  • ALF_ERR_INVAL: Invalid input argument.
  • ALF_ERR_BADF: Invalid ALF handle.
  • ALF_ERR_PERM: The API call is not permitted with the current calling context. The dataset has been associated with a task and thus closed from further buffer additions.
  • ALF_ERR_GENERIC: Generic internal errors.
Related reference
alf_dataset_handle_t
alf_dataset_create
alf_dataset_buffer_add
alf_task_dataset_associate