ds_clear()

Delete a data server variable

Synopsis:

#include <ds.h>

int ds_clear( ds_t dsdes, 
              const char* variable_name );

Arguments:

dsdes: A data server descriptor returned by ds_register().
variable_name: The name of the variable that you want to delete.

Library:

libds

Use the -l ds option to qcc to link against this library.

Description:

The ds_clear() function deletes variable_name from the data server identified by dsdes.

Returns:

0: Success.
-1: An error occurred (errno is set).

Errors:

EBADF: Invalid file descriptor dsdes.
ESRCH: The variable doesn't exist in the data server.

Examples:

See slinger in the Utilities Reference.

Classification:

Safety:
Cancellation point	Yes
Interrupt handler	No
Signal handler	Yes
Thread	Yes

See also:

ds_deregister(), ds_flags()