Initializing help system before first use

hmenum

Purpose
Iterate over all elements of a hashmap.
Synopsis
int hmenum(XPRMhashmap hm, void *ctf, int (*getpair)(void *ctf, unsigned int nb, size_t key, size_t val));
Arguments
hm 
A hashmap
ctf 
Function context for getpair
getpair 
Function to call for each pair <key,value> (may be NULL)
Return value
The number of elements in the hashmap or -1 if the enumeration has been interrupted.
Further information
1. This function enumerates all elements of a hashmap: each pair <key,value> is passed back to the caller through the getpair function that receives its context ( ctf) and the number of elements that have been processed so far in addition to the key and its associated value.
2. The value returned by the getpair function decides how to proceed: if it returns 0 the enumeration continues; with the value -1 the current element will be removed from the hashmap before continuing; any other value will cause the enumeration to terminate (and hmenum will return -1).
Related topics
hmdump.

Parent Topic Miscellaneous

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.