1Net::LDAP::Message(3) User Contributed Perl DocumentationNet::LDAP::Message(3)
2
3
4

NAME

6       Net::LDAP::Message - Message response from LDAP server
7

SYNOPSIS

9        use Net::LDAP;
10

DESCRIPTION

12       Net::LDAP::Message is a base class for the objects returned by the
13       Net::LDAP methods abandon, add, bind, compare, delete, modify, moddn,
14       search and unbind.
15
16       The sub-class Net::LDAP::Search returned by search also defines many
17       methods.
18
19       If the Net::LDAP object is in async mode then all these methods, except
20       "done" and "mesg_id", will cause a wait until the request is completed.
21

METHODS

23       code ( )
24           The code value in the result message from the server. Normally for
25           a success zero will be returned. Constants for the result codes can
26           be imported from the Net::LDAP or Net::LDAP::Constant module.
27
28       control ( )
29           Return a list of controls that were returned from the server.
30
31       control ( OID, ... )
32           Return a list of controls with the given OIDs that were returned
33           from the server.
34
35       dn ( )
36           The DN in the result message from the server.
37
38       done ( )
39           Returns true if the request has been completed.
40
41       error ( )
42           Returns the error message in the result message from the server. If
43           the server did not include an error message, then the result of
44           ldap_error_desc with the error code from the result message.
45
46       error_name ( )
47           Returns the name of the error code in the result message from the
48           server. See ldap_error_name for a detailed description of the
49           return value.
50
51       error_text ( )
52           Returns the short text description of the error code in the result
53           message from the server. See ldap_error_text for a detailed
54           description of the return value.
55
56       error_desc ( )
57           Returns a long text description of the error code in the result
58           message from the server. See ldap_error_desc for a detailed
59           description of the return value.
60
61       is_error ( )
62           Returns true if the result code is considered to be an error for
63           the operation.
64
65       mesg_id ( )
66           The message id of the request message sent to the server.
67
68       referrals ( )
69           Returns a list of referrals from the result message.
70
71       server_error ( )
72           The error message returned by the server, or "undef" if the server
73           did not provide a message.
74
75       sync ( )
76           Wait for the server to complete the request.
77

SEE ALSO

79       Net::LDAP, Net::LDAP::Search, Net::LDAP::Constant, Net::LDAP::Util
80

ACKNOWLEDGEMENTS

82       This document is based on a document originally written by Russell
83       Fulton <r.fulton@auckland.ac.nz>.
84

AUTHOR

86       Graham Barr <gbarr@pobox.com>
87
88       Please report any bugs, or post any suggestions, to the perl-ldap
89       mailing list <perl-ldap@perl.org>.
90

92       Copyright (c) 1997-2004 Graham Barr. All rights reserved. This program
93       is free software; you can redistribute it and/or modify it under the
94       same terms as Perl itself.
95
96
97
98perl v5.12.0                      2008-06-30             Net::LDAP::Message(3)
Impressum