Netscape DIRECTORY SERVER 6.1 - PLUG-IN Manual page 275

Syntax
#include "slapi-plugin.h"
Slapi_Backend* slapi_get_first_backend(char **cookie);
Parameters
This function takes the following parameter:
cookie
Returns
This function returns one of the following values:
• A pointer to the backend structure of the first backend, and its index, in the
parameter
cookie
• if there is no backend.
NULL
Description
This function returns a pointer to the backend structure of the first backend. If you
wish to iterate through all of the backends, use this function in conjunction with
slapi_get_next_backend()
Slapi_Backend *be = NULL;
char *cookie = NULL;
be = slapi_get_first_backend (&cookie);
while (be )
{
...
be = slapi_get_next_backend (cookie);
}
slapi_ch_free ((void**)&cookie);
Memory Concerns
Free the cookie parameter after the iteration using
See Also
slapi_get_next_backend()
Output parameter containing the index of the returned backed.
This is useful for calls to slapi_get_next_backend().
Contains 0 in output if no backend is returned.
. For example:
Functions for Managing Backend Operations
.
slapi_ch_free()
Chapter 15 Function Reference 275