Netscape DIRECTORY SERVER 6.1 - PLUG-IN Manual page 205

Slapi_PBlock
Contains name-value pairs, known as parameter blocks, that you can get or set for
each LDAP operation.
Syntax
#include slapi-plugin.h
typedef struct slapi_pblock Slapi_PBlock;
Description
Slapi_PBlock
from the server and set information to be used by the server.
For most types of plug-in functions, the server passes in a
structure that typically includes data relevant to the operation being processed.
You can get the value of a parameter by calling the
For example, when the plug-in function for an LDAP bind operation is called, the
server puts the DN and credentials in the
SLAPI_BIND_CREDENTIALS
call
slapi_pblock_get()
authentication.
For plug-in initialization functions, you can use the
pass information to the server, such as the description of your plug-in and the
names of your plug-in functions. You can set the value of a parameter by calling
the
slapi_pblock_set()
For example, in order to register a pre-operation bind plug-in function, you need to
call
slapi_pblock_set()
plug-in function as the
and
The available parameters that you can use depends on the type of plug-in function
you are writing.
The following table summarizes the front-end API functions that you can call to
work with block parameters.
To do this...
Sets up a parameter block so that it
can be used by
slapi_add_internal_pb() for
an internal add operation
contains name-value pairs that you can use to retrieve information
SLAPI_PLUGIN_VERSION
SLAPI_PLUGIN_PRE_BIND_FN
SLAPI_BIND_TARGET
parameters of the
Slapi_PBlock
to get the DN and credentials of the client requesting
function.
to set the version number, description, and name of the
parameters.
Call this function
slapi_add_entry_internal_set_pb()
Chapter 14
Summary of Data Types and Structures
Slapi_PBlock
slapi_pblock_get()
and
structure. You can
structure to
Slapi_PBlock
,
SLAPI_PLUGIN_DESCRIPTION
Data Type and Structure Reference
function.
,
205