1ldap_get_entry_controls(3LDAPL)DAP Library Functionlsdap_get_entry_controls(3LDAP)
2
3
4

NAME

6       ldap_get_entry_controls  - get the LDAP controls included with a direc‐
7       tory entry in a set of search results
8

SYNOPSIS

10       cc-flag ... file...-lldap [ -library ... ]
11       #include <ldap.h>
12
13       int ldap_get_entry_controls(LDAP *ld, LDAPMessage *entry,
14            LDAPControl ***serverctrlsp
15
16

DESCRIPTION

18       The ldap_get_entry_controls() function retrieves the LDAP  v3  controls
19       included  in  a  directory entry in a chain of search results. The LDAP
20       controls are specified in an  array  of  LDAPControl  structures.  Each
21       LDAPControl  structure  represents  an LDAP control. The function takes
22       entry as a parameter, which points to  an  LDAPMessage  structure  that
23       represents an entry in a chain of search results.
24
25
26       The  entry  notification  controls that are used with persistent search
27       controls are the  only  controls  that  are  returned  with  individual
28       entries. Other controls are returned with results sent from the server.
29       You can call ldap_parse_result() to retrieve those controls.
30

ERRORS

32       ldap_get_entry_controls() returns the following error codes.
33
34       LDAP_SUCCESS           LDAP controls were successfully retrieved.
35
36
37       LDAP_DECODING_ERROR    An error occurred when decoding the  BER-encoded
38                              message.
39
40
41       LDAP_PARAM_ERROR       An invalid parameter was passed to the function.
42
43
44       LDAP_NO_MEMORY         Memory cannot be allocated.
45
46

ATTRIBUTES

48       See attributes(5)  for descriptions of the following attributes:
49
50
51
52
53       ┌─────────────────────────────┬─────────────────────────────┐
54       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
55       ├─────────────────────────────┼─────────────────────────────┤
56       │Availability                 │SUNWcsl (32-bit)             │
57       ├─────────────────────────────┼─────────────────────────────┤
58       │                             │SUNWcslx (64-bit)            │
59       ├─────────────────────────────┼─────────────────────────────┤
60       │Interface Stability          │Evolving                     │
61       └─────────────────────────────┴─────────────────────────────┘
62

SEE ALSO

64       ldap_error(3LDAP), ldap_parse_result(3LDAP), attributes(5)
65
66
67
68SunOS 5.11                        6 Jan 2003    ldap_get_entry_controls(3LDAP)
Impressum