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 ( [ OID, ... ] )
29           Return the list of controls that were returned from the server.  If
30           one or more OIDs are given as arguments, return only the controls
31           of the OIDs given.
32
33       dn ( )
34           The DN in the result message from the server.
35
36       done ( )
37           Returns true if the request has been completed.
38
39       error ( )
40           Returns the error message in the result message from the server. If
41           the server did not include an error message, then the result of
42           ldap_error_desc with the error code from the result message.
43
44       error_name ( )
45           Returns the name of the error code in the result message from the
46           server. See ldap_error_name for a detailed description of the
47           return value.
48
49       error_text ( )
50           Returns the short text description of the error code in the result
51           message from the server. See ldap_error_text for a detailed
52           description of the return value.
53
54       error_desc ( )
55           Returns a long text description of the error code in the result
56           message from the server. See ldap_error_desc for a detailed
57           description of the return value.
58
59       is_error ( )
60           Returns true if the result code is considered to be an error for
61           the operation.
62
63       mesg_id ( )
64           The message id of the request message sent to the server.
65
66       referrals ( )
67           Returns a list of referrals from the result message.
68
69       server_error ( )
70           The error message returned by the server, or "undef" if the server
71           did not provide a message.
72
73       sync ( )
74           Wait for the server to complete the request.
75

SEE ALSO

77       Net::LDAP, Net::LDAP::Search, Net::LDAP::Constant, Net::LDAP::Util
78

ACKNOWLEDGEMENTS

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

AUTHOR

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

90       Copyright (c) 1997-2004 Graham Barr. All rights reserved. This program
91       is free software; you can redistribute it and/or modify it under the
92       same terms as Perl itself.
93
94
95
96perl v5.32.1                      2021-02-16             Net::LDAP::Message(3)
Impressum