sieve_hash_next_item
Name
sieve_hash_next_item — Get the next item from a hash argument and add a reference to it
Synopsis
#include "sieve/ecsieve.h"
| int **sieve_hash_first_item** (
| hash, | |
| | iter, | |
| | key, | |
| | item)
; | |
SIEVEARGS * <var class="pdparam">hash</var>
;
ec_hash_iter * <var class="pdparam">iter</var>
;
const char ** <var class="pdparam">key</var>
;
SIEVEARGS ** <var class="pdparam">item</var>
;
Description
Get the next item from a hash argument and add a reference to it.
You must call sieve_arg_delref when you are done using the item.
- hash
-
A pointer to the ec_hash_table of the
SIEVETOKEN value
of the specifiedSIEVEARG
. - iter
-
The hash iterator. For more information about this data type see ec_hash_iter.
- key
-
The key to the hash item you wish to return.
- item
-
The value of the specified
key
.
On success this function returns 1
; on failure, 0
.
It is legal to call this function in any thread.