From 8ac42c089d13dfc5486897fd2e1b22b64d99754d Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 2 Jun 2014 21:40:42 +0000 Subject: [PATCH] Hack together some basic documentation for ldap_parse_result(). Fixes doc bug #54420 (missing documentation for ldap function ldap_parse_result). git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333701 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../ldap/functions/ldap-parse-result.xml | 93 ++++++++++++++++++- 1 file changed, 92 insertions(+), 1 deletion(-) diff --git a/reference/ldap/functions/ldap-parse-result.xml b/reference/ldap/functions/ldap-parse-result.xml index d0de0ca20e..5248c50029 100644 --- a/reference/ldap/functions/ldap-parse-result.xml +++ b/reference/ldap/functions/ldap-parse-result.xml @@ -17,7 +17,98 @@ stringerrmsg arrayreferrals - &warn.undocumented.func; + + Parses an LDAP search result. + + + + + &reftitle.parameters; + + + + link + + + An LDAP link identifier, returned by ldap_connect. + + + + + result_identifier + + + An LDAP result resource, returned by ldap_list or + ldap_search. + + + + + errcode + + + A reference to a variable that will be set to the LDAP error code in + the result, or 0 if no error occurred. + + + + + matcheddn + + + A reference to a variable that will be set to a matched DN if one was + recognised within the request, otherwise it will be set to &null;. + + + + + errmsg + + + A reference to a variable that will be set to the LDAP error message in + the result, or an empty string if no error occurred. + + + + + referrals + + + A reference to a variable that will be set to an array set + to all of the referral strings in the result, or an empty array if no + referrals were returned. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + + <function>ldap_parse_result</function> example + + + ]]> + + +