net::ldap::message(3pm) [debian man page]
Net::LDAP::Message(3pm) User Contributed Perl Documentation Net::LDAP::Message(3pm) NAME
Net::LDAP::Message - Message response from LDAP server SYNOPSIS
use Net::LDAP; DESCRIPTION
Net::LDAP::Message is a base class for the objects returned by the Net::LDAP methods abandon, add, bind, compare, delete, modify, moddn, search and unbind. The sub-class Net::LDAP::Search returned by search also defines many methods. If the Net::LDAP object is in async mode then all these methods, except "done" and "mesg_id", will cause a wait until the request is completed. METHODS
code ( ) The code value in the result message from the server. Normally for a success zero will be returned. Constants for the result codes can be imported from the Net::LDAP or Net::LDAP::Constant module. control ( ) Return a list of controls that were returned from the server. control ( OID, ... ) Return a list of controls with the given OIDs that were returned from the server. dn ( ) The DN in the result message from the server. done ( ) Returns true if the request has been completed. error ( ) Returns the error message in the result message from the server. If the server did not include an error message, then the result of ldap_error_desc with the error code from the result message. error_name ( ) Returns the name of the error code in the result message from the server. See ldap_error_name for a detailed description of the return value. error_text ( ) Returns the short text description of the error code in the result message from the server. See ldap_error_text for a detailed description of the return value. error_desc ( ) Returns a long text description of the error code in the result message from the server. See ldap_error_desc for a detailed description of the return value. is_error ( ) Returns true if the result code is considered to be an error for the operation. mesg_id ( ) The message id of the request message sent to the server. referrals ( ) Returns a list of referrals from the result message. server_error ( ) The error message returned by the server, or "undef" if the server did not provide a message. sync ( ) Wait for the server to complete the request. SEE ALSO
Net::LDAP, Net::LDAP::Search, Net::LDAP::Constant, Net::LDAP::Util ACKNOWLEDGEMENTS
This document is based on a document originally written by Russell Fulton <r.fulton@auckland.ac.nz>. AUTHOR
Graham Barr <gbarr@pobox.com> Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap@perl.org>. COPYRIGHT
Copyright (c) 1997-2004 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.14.2 2012-01-29 Net::LDAP::Message(3pm)
Check Out this Related Man Page
Net::LDAP::Search(3) User Contributed Perl Documentation Net::LDAP::Search(3) NAME
Net::LDAP::Search - Object returned by Net::LDAP search method SYNOPSIS
use Net::LDAP; $mesg = $ldap->search( @search_args ); @entries = $mesg->entries; DESCRIPTION
A Net::LDAP::Search object is returned from the search method of a Net::LDAP object. It is a container object which holds the results of the search. METHODS
Net::LDAP::Search inherits from Net::LDAP::Message, and so supports all methods defined in Net::LDAP::Message. as_struct ( ) Returns a reference to a HASH, where the keys are the DNs of the results and the values are HASH references. These second level HASHes hold the attributes such that the keys are the attribute names, in lowercase, and the values are references to an ARRAY holding the values. This method will block until the whole search request has finished. count ( ) Returns the number of entries returned by the server. This method will block until the whole search request has finished. entry ( INDEX ) Return the N'th entry, which will be a Net::LDAP::Entry object. If INDEX is greater than the total number of entries returned then "undef" will be returned. This method will block until the search request has returned enough entries. entries ( ) Return an array of Net::LDAP::Entry objects that were returned from the server. This method will block until the whole search request has finished. pop_entry ( ) Pop an entry from the internal list of Net::LDAP::Entry objects for this search. If there are no more entries then "undef" is returned. This call will block if the list is empty, until the server returns another entry. references ( ) Return a list of references that the server returned. This will be a list of Net::LDAP::Reference objects. sorted ( ) Return a list Net::LDAP::Entry objects, sorted by their DNs. The sorting is done on the client side using Perl's alphanumerical sort operator "cmp". sorted ( ATTR, ... ) Return a list of Net::LDAP::Entry objects, sorted by the specified attributes. The attributes are compared in the order specified, each only being compared if all the prior attributes compare equal. The sorting is done on the client side using Perl's alphanumerical sort operator "cmp". shift_entry ( ) Shift an entry from the internal list of Net::LDAP::Entry objects for this search. If there are no more entries then "undef" is returned. This call will block if the list is empty, until the server returns another entry. SEE ALSO
Net::LDAP, Net::LDAP::Message, Net::LDAP::Entry, Net::LDAP::Reference ACKNOWLEDGEMENTS
This document is based on a document originally written by Russell Fulton <r.fulton@auckland.ac.nz>. AUTHOR
Graham Barr <gbarr@pobox.com> Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap@perl.org>. COPYRIGHT
Copyright (c) 1997-2004 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.16.2 2012-09-20 Net::LDAP::Search(3)