slapi_get_response_controls()

Edit online

This slapi routine calls and accesses the list of response controls.

Syntax
#include <slapi-plugin.h>
int slapi_get_response_controls(
Slapi_PBlock *pb,
LDAPControl ***responseControls);
Input Parameters
pb
A parameter block. The Slapi_PBlock must contain:
  • SLAPI_CONNECTION - Connection structure that represents the client.
  • SLAPI_OPERATION - Operation structure.
Output Parameters
responseControls
Specifies a pointer that returns a deep copy of the response controls that the server currently is associated with the operation. Response controls are the controls that are returned to the client when the response is sent. Return codes are listed:
  • LDAP_SUCCESS - Successfully retrieved the list of controls.
  • LDAP_PARAM_ERROR - Parameters that are passed in were invalid.
Usage
The slapi_get_response_controls() routine must be called when the program accesses the list of response controls that the server is associated with a single operation. The caller must free the local list of controls after its use.