[Summary view] [Print] [Text view]

   1  =head1 NAME
   2  
   3  Net::LDAP::Message - Message response from LDAP server
   4  
   5  =head1 SYNOPSIS
   6  
   7   use Net::LDAP;
   8  
   9  =head1 DESCRIPTION
  10  
  11  B<Net::LDAP::Message> is a base class for the objects returned by the
  12  L<Net::LDAP> methods
  13  L<abandon|Net::LDAP/abandon>,
  14  L<add|Net::LDAP/add>,
  15  L<bind|Net::LDAP/bind>,
  16  L<compare|Net::LDAP/compare>,
  17  L<delete|Net::LDAP/delete>,
  18  L<modify|Net::LDAP/modify>,
  19  L<moddn|Net::LDAP/moddn>,
  20  L<search|Net::LDAP/search> and
  21  L<unbind|Net::LDAP/unbind>.
  22  
  23  The sub-class L<Net::LDAP::Search> returned by
  24  L<search|Net::LDAP/search> also defines many methods.
  25  
  26  If the L<Net::LDAP> object is in async mode then all these methods,
  27  except C<done> and C<mesg_id>, will cause a wait until the request is completed.
  28  
  29  =head1 METHODS
  30  
  31  =over 4
  32  
  33  =item code ( )
  34  
  35  The code value in the result message from the server. Normally for a
  36  success zero will be returned. Constants for the result codes can be
  37  imported from the L<Net::LDAP> or L<Net::LDAP::Constant> module.
  38  
  39  =item control ( )
  40  
  41  Return a list of controls that were returned from the server.
  42  
  43  =item control ( OID, ... )
  44  
  45  Return a list of controls with the given OIDs that were returned from
  46  the server.
  47  
  48  =item dn ( )
  49  
  50  The DN in the result message from the server.
  51  
  52  =item done ( )
  53  
  54  Returns I<true> if the request has been completed.
  55  
  56  =item error ( )
  57  
  58  Returns the error message in the result message from the server. If
  59  the server did not include an error message, then the result of
  60  L<ldap_error_desc|Net::LDAP::Util/ldap_error_desc> with the error code
  61  from the result message.
  62  
  63  =item error_name ( )
  64  
  65  Returns the name of the error code in the result message from the
  66  server. See L<ldap_error_name|Net::LDAP::Util/ldap_error_name> for a
  67  detailed description of the return value.
  68  
  69  =item error_text ( )
  70  
  71  Returns the short text description of the error code in the result
  72  message from the server. See
  73  L<ldap_error_text|Net::LDAP::Util/ldap_error_text> for a detailed
  74  description of the return value.
  75  
  76  =item error_desc ( )
  77  
  78  Returns a long text description of the error code in the result
  79  message from the server. See
  80  L<ldap_error_desc|Net::LDAP::Util/ldap_error_desc> for a detailed
  81  description of the return value.
  82  
  83  =item is_error ( )
  84  
  85  Returns I<true> if the result code is considered to be an error for
  86  the operation.
  87  
  88  =item mesg_id ( )
  89  
  90  The message id of the request message sent to the server.
  91  
  92  =item referrals ( )
  93  
  94  Returns a list of referrals from the result message.
  95  
  96  =item server_error ( )
  97  
  98  The error message returned by the server, or C<undef> if the server
  99  did not provide a message.
 100  
 101  =item sync ( )
 102  
 103  Wait for the server to complete the request.
 104  
 105  =back
 106  
 107  =head1 SEE ALSO
 108  
 109  L<Net::LDAP>,
 110  L<Net::LDAP::Search>,
 111  L<Net::LDAP::Constant>,
 112  L<Net::LDAP::Util>
 113  
 114  =head1 ACKNOWLEDGEMENTS
 115  
 116  This document is based on a document originally written by Russell
 117  Fulton E<lt>r.fulton@auckland.ac.nzE<gt>.
 118  
 119  =head1 AUTHOR
 120  
 121  Graham Barr E<lt>gbarr@pobox.comE<gt>
 122  
 123  Please report any bugs, or post any suggestions, to the perl-ldap
 124  mailing list E<lt>perl-ldap@perl.orgE<gt>.
 125  
 126  =head1 COPYRIGHT
 127  
 128  Copyright (c) 1997-2004 Graham Barr. All rights reserved. This program
 129  is free software; you can redistribute it and/or modify it under the
 130  same terms as Perl itself.
 131  
 132  =cut