| SYNOPSIS |
#include <dkim.h>
DKIM_STAT dkim_nametable_next(
DKIM_ITER_CTX *ctx,
const char **name,
int *code
);
Get the next entry on the iteration over the table.
|
|---|
| DESCRIPTION |
| Called When |
dkim_nametable_next() can be called with valid
DKIM_ITER_CTX.
|
|
|---|
| ARGUMENTS |
| Argument | Description |
|---|
| ctx |
Pointer to a valid
DKIM_ITER_CTX.
|
| name |
Pointer to a variable of type (char **) which will be
set to point to the name in the next entry of the iteration conext.
|
| code |
Pointer to a variable of type (int *) which will be
set to the mnemonic code in the next entry of the iteration context.
|
|
|---|
| RETURN VALUES |
| Return Value | Description |
|---|
| DKIM_STAT_OK |
The next entry of the table is retrieved successfully.
|
| DKIM_STAT_ITER_EOT |
The iteration has reached to the end of the table.
(name and code are not set)
|
|
|---|
| NOTES |
- Pointer arguments name and code would be set only if
DKIM_STAT_OK is returned.
- The iteration context ctx should be released by the caller
by using dkim_iter_ctx_free() when the iteration is no
longer needed.
|