Sun Java System Directory Server Enterprise Edition 6.2 Developer's Guide

Slapi_PBlock

Opaque structure representing, called a parameter block, containing name-value pairs updated in the context of a server operation.

Syntax

#include "slapi-plugin.h"
typedef struct slapi_pblock Slapi_PBlock;

Description

For most types of plug-in functions, the server passes in a parameter block (Slapi_PBlock) including data relevant to the operation being processed. Access the data using slapi_pblock_get().

Plug-in initialization functions register at least the plug-in API version, plug-in descriptions, and other plug-in functions using slapi_pblock_set() .

The specific parameters available in a Slapi_PBlock structure depend on the type of plug-in function and the context of the LDAP operation. Refer to the “Parameter Block Reference,” on page 335 for details on the name-value pairs available to specific types of plug-in functions.

See Also

Table 16–1

Chapter 15, Data Type and Structure Reference

For examples of Slapi_PBlock use, refer to the sample plug-ins under $INSTALL_DIR/examples/.