The function has the following parameters:
- The index of the enumeration. To begin an enumeration, this argument is set to zero. To continue an enumeration (thereby getting successive addresses from the host entry structure), the value should be set to the function's last returned value. The enumeration is complete when a value of zero is returned.
- A pointer to a
PRHostEntstructure obtained from
- The port number to be assigned as part of the
PRNetAddrstructure. This parameter is not checked for validity.
- On input, a pointer to a
PRNetAddrstructure. On output, this structure is filled in by the runtime if the result of the call is greater than 0.
The function returns one of the following values:
- If successful, the function returns the value you should specify in the
enumIndexparameter for the next call of the enumerator. If the function returns 0, the enumeration is ended.
- If unsuccessful, the function returns -1. You can retrieve the reason for the failure by calling
PR_EnumerateHostEnt is a stateless enumerator. The principle input, the
PRHostEnt structure, is not modified.