ldap_parse_result.3 3.99 KB
Newer Older
1
.TH LDAP_PARSE_RESULT 3 "RELEASEDATE" "OpenLDAP LDVERSION"
2
.\" $OpenLDAP$
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
3
.\" Copyright 1998-2020 The OpenLDAP Foundation All Rights Reserved.
4
5
6
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.SH NAME
ldap_parse_result \- Parsing results
7
.SH LIBRARY
Howard Chu's avatar
Howard Chu committed
8
OpenLDAP LDAP (libldap, \-lldap)
9
10
11
12
13
14
15
16
.SH SYNOPSIS
.nf
.ft B
#include <ldap.h>
.LP
.ft B
int ldap_parse_result( LDAP *ld, LDAPMessage *result,
	int *errcodep, char **matcheddnp, char **errmsgp,
17
18
	char ***referralsp, LDAPControl ***serverctrlsp,
	int freeit )
19
20
21
22
23
24
25
26
.LP
.ft B
int ldap_parse_sasl_bind_result( LDAP *ld, LDAPMessage *result,
	struct berval **servercredp, int freeit )
.LP
.ft B
int ldap_parse_extended_result( LDAP *ld, LDAPMessage *result,
	char **retoidp, struct berval **retdatap, int freeit )
27
28
29
30
31
.LP
.ft B
int ldap_parse_intermediate( LDAP *ld, LDAPMessage *result,
	char **retoidp, struct berval **retdatap,
	LDAPControl ***serverctrlsp, int freeit )
32
33
34
35
36
37
.SH DESCRIPTION
.LP
These routines are used to extract information from a result message.
They will operate on the first result message in a chain of search
results (skipping past other message types). They take the \fIresult\fP
as returned by a call to
38
.BR ldap_result (3),
39
40
.BR ldap_search_s (3)
or
41
.BR ldap_search_st (3).
42
In addition to
43
.BR ldap_parse_result() ,
44
45
46
47
48
the routines
.B ldap_parse_sasl_bind_result()
and
.B ldap_parse_extended_result()
are used to get all the result information from SASL bind and extended
49
50
51
operations. To extract information from intermediate responses,
.B ldap_parse_intermediate()
can be used.
52
53
54
55
56
57
58
59
.LP
The \fIerrcodep\fP parameter will be filled in with the result code from
the result message.
.LP
The server might supply a matched DN string in the message indicating
how much of a name in a request was recognized. The \fImatcheddnp\fP
parameter will be filled in with this string if supplied, else it will
be NULL. If a string is returned, it should be freed using
60
.BR ldap_memfree (3).
61
62
63
.LP
The \fIerrmsgp\fP parameter will be filled in with the error message
field from the parsed message. This string should be freed using
64
.BR ldap_memfree (3).
65
66
67
.LP
The \fIreferralsp\fP parameter will be filled in with an allocated array of
referral strings from the parsed message. This array should be freed using
68
.BR ldap_memvfree (3).
69
70
71
72
If no referrals were returned, \fI*referralsp\fP is set to NULL.
.LP
The \fIserverctrlsp\fP parameter will be filled in with an allocated array of
controls copied from the parsed message. The array should be freed using
73
.BR ldap_controls_free (3).
74
75
76
77
78
If no controls were returned, \fI*serverctrlsp\fP is set to NULL.
.LP
The \fIfreeit\fP parameter determines whether the parsed message is
freed or not after the extraction. Any non-zero value will make it
free the message. The
79
.BR ldap_msgfree (3)
80
81
82
83
84
routine can also be used to free the message later.
.LP
For SASL bind results, the \fIservercredp\fP parameter will be filled in
with an allocated berval structure containing the credentials from the
server if present. The structure should be freed using
85
.BR ber_bvfree (3).
86
.LP
87
For extended results and intermediate responses, the \fIretoidp\fP parameter will be filled in
88
89
with the dotted-OID text representation of the name of the extended
operation response. The string should be freed using
90
.BR ldap_memfree (3).
91
92
If no OID was returned, \fI*retoidp\fP is set to NULL.
.LP
93
For extended results and intermediate responses, the \fIretdatap\fP parameter will be filled in
94
95
with a pointer to a berval structure containing the data from the
extended operation response. The structure should be freed using
96
.BR ber_bvfree (3).
97
98
99
100
101
102
103
104
If no data were returned, \fI*retdatap\fP is set to NULL.
.LP
For all the above result parameters, NULL values can be used in calls
in order to ignore certain fields.
.SH ERRORS
Upon success LDAP_SUCCESS is returned. Otherwise the values of the
result parameters are undefined.
.SH SEE ALSO
105
106
107
108
.BR ldap (3),
.BR ldap_result (3),
.BR ldap_search (3),
.BR ldap_memfree (3),
109
.BR ldap_memvfree (3),
110
111
.BR ldap_get_values (3),
.BR ldap_controls_free (3),
112
113
.BR lber-types (3)
.SH ACKNOWLEDGEMENTS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
114
.so ../Project