ck_hs_remove (3) - Linux Man Pages

ck_hs_remove: remove key from a hash set

NAME

ck_hs_remove - remove key from a hash set

LIBRARY

Concurrency Kit (libck, -lck)

SYNOPSIS

In ck_hs.h Ft void * Fn ck_hs_remove ck_hs_t *hs unsigned long hash const void *key

DESCRIPTION

The Fn ck_hs_remove 3 function will attempt to remove the key specified by the Fa key argument in the hash set pointed to by the Fa hs argument. The key specified by Fa key is expected to have the hash value specified by the Fa hash argument (which was previously generated using the CK_HS_HASH3 macro).

If the call to Fn ck_hs_remove 3 was successful then the key contained in the hash set is returned. If the key was not a member of the hash set then NULL is returned.

RETURN VALUES

Upon successful completion, Fn ck_hs_remove 3 returns a pointer to a key and otherwise returns NULL on failure.

ERRORS

Behavior is undefined if Fa key or Fa hs are uninitialized.

SEE ALSO

ck_hs_init3, ck_hs_move3, ck_hs_destroy3, CK_HS_HASH3, ck_hs_iterator_init3, ck_hs_next3, ck_hs_get3, ck_hs_put3, ck_hs_put_unique3, ck_hs_set3, ck_hs_fas3, ck_hs_grow3, ck_hs_gc3, ck_hs_rebuild3, ck_hs_count3, ck_hs_reset3, ck_hs_reset_size3, ck_hs_stat3

Additional information available at http://concurrencykit.org/