1. drmaa2_dict_free(3)
2. DRMAA2
3. drmaa2_dict_free(3)

NAME

drmaa2_dict_free - drmaa2_dict_free, Frees a DRMAA2 dictionary.

SYNOPSIS

#include "drmaa2.h"

void drmaa2_dict_free(drmaa2_dict * dict);

DESCRIPTION

Frees the DRMAA2 dictionary and sets it to NULL. If the dictionary was created with a callback function, this function is called for all elements of the dictionary.

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_set(dict, strdup("key2"), strdup("")) != DRMAA2_SUCCESS) {
   printf("Error: Could not set a new value in the dictionary.\n");
   return;
}

/* 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_free(3)