Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY CUSTOMIZATION, Manual

Page: 422 / 612

Functions for Managing Parameter Block
422 Netscape Directory Server Plug-In Programmer’s Guide • December 2003
If you reuse the pointer in this way, it makes it easier to identify a Segmentation
Fault, rather than using some difficult method to detect memory leaks or other
abnormal behavior.
It is safe to call this function with a NULL pointer. For example:
Slapi_PBlock *pb = NULL;
slapi_pblock_destroy(pb);
This saves the trouble of checking for NULL before calling
slapi_pblock_destroy()
.
See Also
slapi_pblock_new()
slapi_pblock_get()
Gets the value of a name-value pair from a parameter block.
Syntax
#include “slapi-plugin.h”
int slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value );
Parameters
This function takes the following parameters:
Returns
This function returns one of the following values:
• 0 if successful.
• -1 if an error occurs (for example, if an invalid ID is specified).
Memory Concerns
The void
*value
argument should always be a pointer to the type of value you are
retrieving:
pb
Parameter block.
arg
ID of the name-value pair that you want to get. For a list of IDs that you
can specify, see Chapter 16, “Parameter Block Reference.”
value
Pointer to the value retrieved from the parameter block.