1. drmaa2_dict_del(3)
2. DRMAA2
3. drmaa2_dict_del(3)

NAME

drmaa2_dict_del - drmaa2_dict_del, Deletes a key value pair from a dictionary.

SYNOPSIS

#include "drmaa2.h"

drmaa2_error drmaa2_dict_del(drmaa2_dict dict, const char *key)

DESCRIPTION

Deletes a key/value pair out of a given dictionary. If the dictionary was created using a callback function. the function is executed before the values are deleted. This is usually used for automatically freeing allocated memory.

RETURN VALUES

In case of success DRMAA2_SUCCESS is returned otherwise the error code indcating the error is returned.

EXAMPLE

static void drmaa2_dict_string_free(char** key, char** value)
{
   drmaa2_string_free(key);
   drmaa2_string_free(value);
}

/* ... */

/* Create dictionary for job environment variables. */
drmaa2_dict dict = drmaa2_dict_create((drmaa2_dict_entryfree)drmaa2_dict_string_free);

if (dict == NULL) {
   printf("Error: Could not create a new dictionary.\n");
   return;
}

if (drmaa2_dict_set(dict, strdup("key"), strdup("value")) != DRMAA2_SUCCESS) {
   printf("Error: Could not set a new value in the dictionary.\n");
   return;
}

if (drmaa2_dict_del(dict, "key") != DRMAA2_SUCCESS) {
   printf("Error during deletion of the key value pair.");
}

/* Frees strings implicitly. */
drmaa2_dict_free(&dict);

SEE ALSO

drmaa2_dict_create(3), drmaa2_dict_free(3), drmaa2_dict_list(3), drmaa2_dict_has(3), drmaa2_dict_get(3), drmaa2_dict_del(3), drmaa2_dict_set(3)

AUTHOR

Copyright Univa Corporation 2013

1. Univa Corporation
2. October 2013
3. drmaa2_dict_del(3)