vslConvDeleteTask/vslCorrDeleteTask
vslConvDeleteTask
/vslCorrDeleteTask
Destroys the task object and frees the memory.
Syntax
errcode
=
vslConvDeleteTask
(
task
);
errcode
=
vslCorrDeleteTask
(
task
);
Include Files
- mkl.h
Input Parameters
Name | Type | Description |
---|---|---|
task | VSLConvTaskPtr* for vslConvDeleteTask VSLCorrTaskPtr* for vslCorrDeleteTask | Pointer to the task descriptor. |
Output Parameters
Name | Type | Description |
---|---|---|
errcode | int | Contains 0 if the task object is deleted successfully. Contains an error code if an error occurred. |
Description
The
vslConvDeleteTask
/vslCorrvDeleteTask
routine deletes the task descriptor object and frees any working memory and
the memory allocated for the data structure. The task pointer is set to NULL
.Note that if the
vslConvDeleteTask
/vslCorrvDeleteTask
routine does not delete the task successfully, the routine returns an error code. This error code has no relation to the task status code and does not change it.You can use the
NULL
task pointer in calls to destructor routines. In this case, the routine terminates with no system crash.