Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY CUSTOMIZATION, Manual

Page: 568 / 612

Parameters Accessible to All Plug-Ins
568 Netscape Directory Server Plug-In Programmer’s Guide • December 2003
Information About the Plug-In
The parameters listed below specify information about the plug-in that is available
to all plug-in functions defined in the current library. These parameters are
available for all types of plug-ins.
Types of Plug-Ins
The
SLAPI_PLUGIN_TYPE
parameter can have one of the following values, which
identifies the type of the current plug-in:
Parameter ID Data Type Description
SLAPI_PLUGIN void *
Pointer to the internal server representation of this
plug-in.
SLAPI_PLUGIN_PRIVATE void *
Private data that you want passed to your plug-in
functions.
SLAPI_PLUGIN_TYPE int
Specifies the type of plug-in function (see “Types of
Plug-Ins” on page 568)
SLAPI_PLUGIN_ARGV char **
NULL-terminated array of command-line arguments
specified for the
plugin
directive in the server
configuration file.
SLAPI_PLUGIN_ARGC int
Number of command-line arguments specified for the
plugin
directive in the server configuration file.
SLAPI_PLUGIN_VERSION char *
Specifies the version of the plug-in function (see
“Version Information” on page 569).
SLAPI_PLUGIN_OPRETURN int
Specifies the return value of the LDAP operation that
has just been processed.
SLAPI_PLUGIN_OBJECT void *
Reserved for internal use only — used with filter
processing.
SLAPI_PLUGIN_DESTROY_FN void *
Reserved for internal use only — used with filter
processing.
SLAPI_PLUGIN_DESCRIPTION char *
Provides a description of this plug-in function.
SLAPI_PLUGIN_IDENTITY char *
Identifies this plug-in function.
Defined Constant Description
SLAPI_PLUGIN_DATABASE
Deprecated.