perldoc > Net::LDAP::Message

man perldoc info pydoc3 ri search

📦 Net::LDAP::Message

📛 NAME

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

🚀 Quick Reference

Use Case	Command	Description
Check if operation succeeded	$msg->is_error()	Returns true if result code is an error
Get LDAP result code	$msg->code()	Integer result code from server
Get error message	$msg->error()	Returns error message or ldap_error_desc
Get Distinguished Name	$msg->dn()	DN from result message
Wait for server completion	$msg->sync()	Wait until request is completed
Get message ID	$msg->mesg_id()	Message ID of the request sent
Get controls	$msg->control()	List of controls returned from server
Get referrals	$msg->referrals()	List of referrals from result

📄 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([OID, ...]) — Return the list of controls that were returned from the server. If one or more OIDs are given as arguments, return only the controls of the OIDs given.
• 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 AT auckland.nz>.

✍️ AUTHOR

Graham Barr <gbarr AT pobox.com>

Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap AT 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.

📦 Net::LDAP::Message 📛 NAME 🚀 Quick Reference 📄 SYNOPSIS 📖 DESCRIPTION 🔧 METHODS 📚 SEE ALSO 🙏 ACKNOWLEDGEMENTS ✍️ AUTHOR ©️ COPYRIGHT