Initializing help system before first use

XPRMgetnextlistelt

XPRMgetnextlistelt


Purpose
Get the next element of a list.
Synopsis
void *XPRMgetnextlistelt(XPRMlist list, void *ref, int *type, XPRMalltypes *value);
Arguments
list 
Reference to a list
ref 
Reference pointer or NULL
type 
Returned type
value 
Pointer to an area where the result is returned
Return value
Reference pointer for the next call to XPRMgetnextlistelt.
Further information
This function is used to enumerate elements of a list. The second parameter is used to store the current location in the list; if this parameter is NULL, the first element of the list is returned. This function returns NULL if it is called with the reference to the last element. Otherwise, the returned value can be used as the input parameter ref to get the following element and so on. The function returns in the third argument the type of the object stored in value (as a type code): this corresponds to the value returned by XPRMgetlisttype if all elements have the same type.
Related topics