Writing Extended Operation Functions - Netscape DIRECTORY SERVER 7.0 - PLUG-IN Manual

Writing Extended Operation Functions

Writing Extended Operation Functions
Like other plug-in functions, extended operation functions pass a single
parameter block (
following example declaration:
int my_ext_func( Slapi_PBlock *pb );
Extended operation functions should return a value of
a non-zero value if they are unsuccessful.
When the Directory Server receives an extended operation request, the front-end
calls the extended operation function with the OID value specified in the request.
The front-end makes the following information available to the extended function
in the form of parameters in a parameter block.
Table 10-1
Parameter ID
SLAPI_EXT_OP_REQ_OID
SLAPI_EXT_OP_REQ_VALUE
SLAPI_EXT_OP_RET_OID
SLAPI_EXT_OP_RET_VALUE
Typically, your function should perform an operation on the value specified in
the
SLAPI_EXT_OP_REQ_VALUE
completes, your function should return a single value, according to the following:
• If your function has sent a result code back to the client, you should return the
value
front-end does not need to send a result code.
• If your function has not sent a result code back to the client (for example, if the
result is
The front-end will send this result code back to the client.
128 Netscape Directory Server Plug-in Programmer's Guide • October 2004
Slapi_PBlock
Extended Function Parameter Block Arguments
SLAPI_PLUGIN_EXTENDED_SENT_RESULT
), your function should return an LDAP result code.
LDAP_SUCCESS
) and return an integer value, as shown in the
Data Type Description
Object ID (OID) of the extended
char *
operation specified in the
request.
Value specified in the request.
struct
berval*
Object ID (OID) that you want
char *
sent back to the client.
Value that you want sent back
struct
to the client.
berval*
parameter. After the extended operation
. This indicates that the
if they are successful and
0