Mozilla::LDAP::API(3pm)

1API(3)                User Contributed Perl Documentation               API(3)
2
3
4

NAME

6         Mozilla::LDAP::API - Perl methods for LDAP C API calls
7

SYNOPSIS

9         use Mozilla::LDAP::API;
10              or
11         use Mozilla::LDAP::API qw(:api :ssl :constant);
12              or
13         use Mozilla::LDAP::API qw(:api :ssl :apiv3 :constant);
14              or
15         use Mozilla::LDAP::API qw(:api :ssl :apiv3 :nspr :constant);
16

DESCRIPTION

18       This package offers a direct interface to the LDAP C API calls from
19       Perl.  It is used internally by the other Mozilla::LDAP modules.  It is
20       highly suggested that you use the object oriented interface in
21       Mozilla::LDAP::Conn and Mozilla::LDAP::Entry unless you need to use
22       asynchronous calls or other functionality not available in the OO
23       interface.
24

THIS DOCUMENT

26       This document has a number of known errors that will be corrected in
27       the next revision.  Since it is not expected that users will need to
28       use this interface frequently, priority was placed on other documents.
29       You can find examples of how to actually use the API calls under the
30       test_api directory.
31

CREATING AN ADD/MODIFY HASH

33       For the add and modify routines you will need to generate a list of
34       attributes and values.
35
36       You will do this by creating a HASH table.  Each attribute in the hash
37       contains associated values.  These values can be one of three things.
38
39         - SCALAR VALUE    (ex. "Clayton Donley")
40         - ARRAY REFERENCE (ex. ["Clayton Donley","Clay Donley"])
41         - HASH REFERENCE  (ex. {"r",["Clayton Donley"]}
42              note:  the value inside the HASH REFERENCE must currently
43                      be an ARRAY REFERENCE.
44
45       The key inside the HASH REFERENCE must be one of the following for a
46       modify operation:
47         - "a" for LDAP_MOD_ADD (Add these values to the attribute)
48         - "r" for LDAP_MOD_REPLACE (Replace these values in the attribute)
49         - "d" for LDAP_MOD_DELETE (Delete these values from the attribute)
50
51       Additionally, in add and modify operations, you may specify "b" if the
52       attributes you are adding are BINARY (ex. "rb" to replace binary).
53
54       Currently, it is only possible to do one operation per add/modify
55       operation, meaning you can't do something like:
56
57          {"d",["Clayton"],"a",["Clay"]}   <-- WRONG!
58
59       Using any combination of the above value types, you can do things like:
60
61       %ldap_modifications = (
62          "cn", "Clayton Donley",                    # Replace 'cn' values
63          "givenname", ["Clayton","Clay"],           # Replace 'givenname'
64       values
65          "mail", {"a",["donley\@cig.mcel.mot.com"],  #Add 'mail' values
66          "jpegphoto", {"rb",[$jpegphotodata]},      # Replace Binary
67       jpegPhoto );
68
69       Then remember to call the add or modify operations with a REFERENCE to
70       this HASH.
71

API Methods

73       The following are the available API methods for Mozilla::LDAP::API.
74       Many of these items have bad examples and OUTPUT information.  Other
75       information should be correct.
76
77       ldap_abandon(ld,msgid)
78           DESCRIPTION:
79
80           Abandon an asynchronous LDAP operation
81
82           INPUT:
83             ld - LDAP Session Handle
84             msgid - Integer
85
86           OUTPUT:
87             status - Integer
88
89           AVAILABILITY: V2/V3
90
91           EXAMPLE:
92
93             $status = ldap_abandon($ld,$msgid);
94
95       ldap_abandon_ext(ld,msgid,serverctrls,clientctrls)
96           DESCRIPTION:
97
98           Abandon an asynchronous LDAP operation w/ Controls
99
100           INPUT:
101             ld - LDAP Session Handle
102             msgid - Integer
103             serverctrls - LDAP Control List Pointer
104             clientctrls - LDAP Control List Pointer
105
106           OUTPUT:
107             status - Integer
108
109           AVAILABILITY: V3
110
111           EXAMPLE:
112
113             $status = ldap_abandon_ext($ld,$msgid,$serverctrls,$clientctrls);
114
115       ldap_add(ld,dn,attrs)
116           DESCRIPTION:
117
118           Asynchronously add a LDAP entry
119
120           INPUT:
121             ld - LDAP Session Handle
122             dn - String
123             attrs - LDAP Add/Modify Hash
124
125           OUTPUT:
126             status - Integer
127
128           AVAILABILITY: V2/V3
129
130           EXAMPLE:
131
132             $status = ldap_add($ld,$dn,$attrs);
133
134       ldap_add_ext(ld,dn,attrs,serverctrls,clientctrls,msgidp)
135           DESCRIPTION:
136
137           Asynchronously add a LDAP entry w/ Controls
138
139           INPUT:
140             ld - LDAP Session Handle
141             dn - String
142             attrs - LDAP Add/Modify Hash
143             serverctrls - LDAP Control List Pointer
144             clientctrls - LDAP Control List Pointer
145             msgidp - Integer
146
147           OUTPUT:
148             status - Integer
149             msgidp - Integer
150
151           AVAILABILITY: V3
152
153           EXAMPLE:
154
155             $status = ldap_add_ext($ld,$dn,$attrs,$serverctrls,$clientctrls,$msgidp);
156
157       ldap_add_ext_s(ld,dn,attrs,serverctrls,clientctrls)
158           DESCRIPTION:
159
160           Synchronously add a LDAP entry w/ Controls
161
162           INPUT:
163             ld - LDAP Session Handle
164             dn - String
165             attrs - LDAP Add/Modify Hash
166             serverctrls - LDAP Control List Pointer
167             clientctrls - LDAP Control List Pointer
168
169           OUTPUT:
170             status - Integer
171
172           AVAILABILITY: V3
173
174           EXAMPLE:
175
176             $status = ldap_add_ext_s($ld,$dn,$attrs,$serverctrls,$clientctrls);
177
178       ldap_add_s(ld,dn,attrs)
179           DESCRIPTION:
180
181           Synchronously add a LDAP entry
182
183           INPUT:
184             ld - LDAP Session Handle
185             dn - String
186             attrs - LDAP Add/Modify Hash
187
188           OUTPUT:
189             status - Integer
190
191           AVAILABILITY: V2/V3
192
193           EXAMPLE:
194
195             $status = ldap_add_s($ld,$dn,$attrs);
196
197       ldap_ber_free(ber,freebuf)
198           DESCRIPTION:
199
200           Free a BER element pointer
201
202           INPUT:
203             ber - BER Element Pointer
204             freebuf - Integer
205
206           OUTPUT:
207             status - NONE
208
209           AVAILABILITY: V2/V3
210
211           EXAMPLE:
212
213             $status = ldap_ber_free($ber,$freebuf);
214
215       ldap_bind(ld,dn,passwd,authmethod)
216           DESCRIPTION:
217
218           Asynchronously bind to the LDAP server
219
220           INPUT:
221             ld - LDAP Session Handle
222             dn - String
223             passwd - String
224             authmethod - Integer
225
226           OUTPUT:
227             status - Integer
228
229           AVAILABILITY: V2/V3
230
231           EXAMPLE:
232
233             $status = ldap_bind($ld,$dn,$passwd,$authmethod);
234
235       ldap_bind_s(ld,dn,passwd,authmethod)
236           DESCRIPTION:
237
238           Synchronously bind to a LDAP server
239
240           INPUT:
241             ld - LDAP Session Handle
242             dn - String
243             passwd - String
244             authmethod - Integer
245
246           OUTPUT:
247             status - Integer
248
249           AVAILABILITY: V2/V3
250
251           EXAMPLE:
252
253             $status = ldap_bind_s($ld,$dn,$passwd,$authmethod);
254
255       ldap_compare(ld,dn,attr,value)
256           DESCRIPTION:
257
258           Asynchronously compare an attribute/value pair and an entry
259
260           INPUT:
261             ld - LDAP Session Handle
262             dn - String
263             attr - String
264             value - String
265
266           OUTPUT:
267             status - Integer
268
269           AVAILABILITY: V2/V3
270
271           EXAMPLE:
272
273             $status = ldap_compare($ld,$dn,$attr,$value);
274
275       ldap_compare_ext(ld,dn,attr,bvalue,serverctrls,clientctrls,msgidp)
276           DESCRIPTION:
277
278           Asynchronously compare an attribute/value pair and an entry w/
279           Controls
280
281           INPUT:
282             ld - LDAP Session Handle
283             dn - String
284             attr - String
285             bvalue - Binary String
286             serverctrls - LDAP Control List Pointer
287             clientctrls - LDAP Control List Pointer
288             msgidp - Integer
289
290           OUTPUT:
291             status - Integer
292             msgidp - Integer
293
294           AVAILABILITY: V3
295
296           EXAMPLE:
297
298             $status = ldap_compare_ext($ld,$dn,$attr,$bvalue,$serverctrls,$clientctrls,$msgidp);
299
300       ldap_compare_ext_s(ld,dn,attr,bvalue,serverctrls,clientctrls)
301           DESCRIPTION:
302
303           Synchronously compare an attribute/value pair to an entry w/
304           Controls
305
306           INPUT:
307             ld - LDAP Session Handle
308             dn - String
309             attr - String
310             bvalue - Binary String
311             serverctrls - LDAP Control List Pointer
312             clientctrls - LDAP Control List Pointer
313
314           OUTPUT:
315             status - Integer
316
317           AVAILABILITY: V3
318
319           EXAMPLE:
320
321             $status = ldap_compare_ext_s($ld,$dn,$attr,$bvalue,$serverctrls,$clientctrls);
322
323       ldap_compare_s(ld,dn,attr,value)
324           DESCRIPTION:
325
326           Synchronously compare an attribute/value pair to an entry
327
328           INPUT:
329             ld - LDAP Session Handle
330             dn - String
331             attr - String
332             value - String
333
334           OUTPUT:
335             status - Integer
336
337           AVAILABILITY: V2/V3
338
339           EXAMPLE:
340
341             $status = ldap_compare_s($ld,$dn,$attr,$value);
342
343       ldap_control_free(ctrl)
344           DESCRIPTION:
345
346           Free a LDAP control pointer
347
348           INPUT:
349             ctrl - LDAP Control Pointer
350
351           OUTPUT:
352             status - NONE
353
354           AVAILABILITY: V3
355
356           EXAMPLE:
357
358             $status = ldap_control_free($ctrl);
359
360       ldap_controls_count(ctrls)
361           DESCRIPTION:
362
363           Count the number of LDAP controls in a LDAP Control List
364
365           INPUT:
366             ctrls - LDAP Control List Pointer
367
368           OUTPUT:
369             status - Integer
370
371           AVAILABILITY: V3
372
373           EXAMPLE:
374
375             $status = ldap_controls_count($ctrls);
376
377       ldap_controls_free(ctrls)
378           DESCRIPTION:
379
380           Free a list of LDAP controls
381
382           INPUT:
383             ctrls - LDAP Control List Pointer
384
385           OUTPUT:
386             status - NONE
387
388           AVAILABILITY: V3
389
390           EXAMPLE:
391
392             $status = ldap_controls_free($ctrls);
393
394       ldap_count_entries(ld,result)
395           DESCRIPTION:
396
397           Count the number of LDAP entries returned
398
399           INPUT:
400             ld - LDAP Session Handle
401             result - LDAP Message Pointer
402
403           OUTPUT:
404             status - Integer
405
406           AVAILABILITY: V2/V3
407
408           EXAMPLE:
409
410             $count = ldap_count_entries($ld,$result);
411
412       ldap_count_messages(ld,result)
413           DESCRIPTION:
414
415           Count the number of LDAP messages returned
416
417           INPUT:
418             ld - LDAP Session Handle
419             result - LDAP Message Pointer
420
421           OUTPUT:
422             status - Integer
423
424           AVAILABILITY: V3
425
426           EXAMPLE:
427
428             $status = ldap_count_messages($ld,$result);
429
430       ldap_count_references(ld,result)
431           DESCRIPTION:
432
433           Count the number of LDAP references returned
434
435           INPUT:
436             ld - LDAP Session Handle
437             result - LDAP Message Pointer
438
439           OUTPUT:
440             status - Integer
441
442           AVAILABILITY: V3
443
444           EXAMPLE:
445
446             $status = ldap_count_references($ld,$result);
447
448       ldap_create_filter(buf,buflen,pattern,prefix,suffix,attr,value,valwords)
449           DESCRIPTION:
450
451           Create a LDAP search filter
452
453           INPUT:
454             buf - String
455             buflen - Integer
456             pattern - String
457             prefix - String
458             suffix - String
459             attr - String
460             value - String
461             valwords - List Reference
462
463           OUTPUT:
464             status - Integer
465
466           AVAILABILITY: V2/V3
467
468           EXAMPLE:
469
470             $status = ldap_create_filter($buf,$buflen,$pattern,$prefix,$suffix,$attr,$value,$valwords);
471
472       ldap_create_persistentsearch_control(ld,changetypes,changesonly,return_echg_ctrls,ctrl_iscritical,ctrlp)
473           DESCRIPTION:
474
475           Create a persistent search control
476
477           INPUT:
478             ld - LDAP Session Handle
479             changetypes - Integer
480             changesonly - Integer
481             return_echg_ctrls - Integer
482             ctrl_iscritical - Integer
483             ctrlp - LDAP Control List Pointer
484
485           OUTPUT:
486             status - Integer
487             ctrlp - LDAP Control List Pointer
488
489           AVAILABILITY: V3
490
491           EXAMPLE:
492
493             $status = ldap_create_persistentsearch_control($ld,$changetypes,$changesonly,$return_echg_ctrls,$ctrl_iscritical,$ctrlp);
494
495       ldap_create_sort_control(ld,sortKeyList,ctrl_iscritical,ctrlp)
496           DESCRIPTION:
497
498           Create a LDAP sort control
499
500           INPUT:
501             ld - LDAP Session Handle
502             sortKeyList - Sort Key Pointer
503             ctrl_iscritical - Integer
504             ctrlp - LDAP Control List Pointer
505
506           OUTPUT:
507             status - Integer
508             ctrlp - LDAP Control List Pointer
509
510           AVAILABILITY: V3
511
512           EXAMPLE:
513
514             $status = ldap_create_sort_control($ld,$sortKeyList,$ctrl_iscritical,$ctrlp);
515
516       ldap_create_sort_keylist(sortKeyList,string_rep)
517           DESCRIPTION:
518
519           Create a list of keys to be used by a sort control
520
521           INPUT:
522             sortKeyList - Sort Key Pointer
523             string_rep - String
524
525           OUTPUT:
526             status - Integer
527             sortKeyList - Sort Key Pointer
528
529           AVAILABILITY: V3
530
531           EXAMPLE:
532
533             $status = ldap_create_sort_keylist($sortKeyList,$string_rep);
534
535       ldap_create_virtuallist_control(ld,ldvlistp,ctrlp)
536           DESCRIPTION:
537
538           Create a LDAP virtual list control
539
540           INPUT:
541             ld - LDAP Session Handle
542             ctrlp - LDAP Control List Pointer
543
544           OUTPUT:
545             status - Integer
546             ctrlp - LDAP Control List Pointer
547
548           AVAILABILITY: V3
549
550           EXAMPLE:
551
552             $status = ldap_create_virtuallist_control($ld,$ldvlistp,$ctrlp);
553
554       ldap_delete(ld,dn)
555           DESCRIPTION:
556
557           Asynchronously delete a LDAP entry
558
559           INPUT:
560             ld - LDAP Session Handle
561             dn - String
562
563           OUTPUT:
564             status - Integer
565
566           AVAILABILITY: V2/V3
567
568           EXAMPLE:
569
570             $status = ldap_delete($ld,$dn);
571
572       ldap_delete_ext(ld,dn,serverctrls,clientctrls,msgidp)
573           DESCRIPTION:
574
575           Asynchronously delete a LDAP entry w/ Controls
576
577           INPUT:
578             ld - LDAP Session Handle
579             dn - String
580             serverctrls - LDAP Control List Pointer
581             clientctrls - LDAP Control List Pointer
582             msgidp - Integer
583
584           OUTPUT:
585             status - Integer
586             msgidp - Integer
587
588           AVAILABILITY: V3
589
590           EXAMPLE:
591
592             $status = ldap_delete_ext($ld,$dn,$serverctrls,$clientctrls,$msgidp);
593
594       ldap_delete_ext_s(ld,dn,serverctrls,clientctrls)
595           DESCRIPTION:
596
597           Synchronously delete a LDAP entry w/ Controls
598
599           INPUT:
600             ld - LDAP Session Handle
601             dn - String
602             serverctrls - LDAP Control List Pointer
603             clientctrls - LDAP Control List Pointer
604
605           OUTPUT:
606             status - Integer
607
608           AVAILABILITY: V3
609
610           EXAMPLE:
611
612             $status = ldap_delete_ext_s($ld,$dn,$serverctrls,$clientctrls);
613
614       ldap_delete_s(ld,dn)
615           DESCRIPTION:
616
617           Synchronously delete a LDAP entry
618
619           INPUT:
620             ld - LDAP Session Handle
621             dn - String
622
623           OUTPUT:
624             status - Integer
625
626           AVAILABILITY: V2/V3
627
628           EXAMPLE:
629
630             $status = ldap_delete_s($ld,$dn);
631
632       ldap_dn2ufn(dn)
633           DESCRIPTION:
634
635           Change a DN to a "Friendly" name
636
637           INPUT:
638             dn - String
639
640           OUTPUT:
641             status - String
642
643           AVAILABILITY: V2/V3
644
645           EXAMPLE:
646
647             $status = ldap_dn2ufn($dn);
648
649       ldap_err2string(err)
650           DESCRIPTION:
651
652           Return the string value of a LDAP error code
653
654           INPUT:
655             err - Integer
656
657           OUTPUT:
658             status - String
659
660           AVAILABILITY: V2/V3
661
662           EXAMPLE:
663
664             $status = ldap_err2string($err);
665
666       ldap_explode_dn(dn,notypes)
667           DESCRIPTION:
668
669           Split a given DN into its components.  Setting 'notypes' to 1
670           returns the components without their type names.
671
672           INPUT:
673             dn - String
674             notypes - Integer
675
676           OUTPUT:
677             status - NONE
678
679           AVAILABILITY: V2/V3
680
681           EXAMPLE:
682
683             $status = ldap_explode_dn($dn,$notypes);
684
685       ldap_explode_rdn(dn,notypes)
686           DESCRIPTION:
687
688           Split a Relative DN into its components
689
690           INPUT:
691             dn - String
692             notypes - Integer
693
694           OUTPUT:
695             status - NONE
696
697           AVAILABILITY: V2/V3
698
699           EXAMPLE:
700
701             $status = ldap_explode_rdn($dn,$notypes);
702
703       ldap_extended_operation(ld,requestoid,requestdata,serverctrls,clientctrls,msgidp)
704           DESCRIPTION:
705
706           Perform an asynchronous extended operation
707
708           INPUT:
709             ld - LDAP Session Handle
710             requestoid - String
711             requestdata - Binary String
712             serverctrls - LDAP Control List Pointer
713             clientctrls - LDAP Control List Pointer
714             msgidp - Integer
715
716           OUTPUT:
717             status - Integer
718             msgidp - Integer
719
720           AVAILABILITY: V3
721
722           EXAMPLE:
723
724             $status = ldap_extended_operation($ld,$requestoid,$requestdata,$serverctrls,$clientctrls,$msgidp);
725
726       ldap_extended_operation_s(ld,requestoid,requestdata,serverctrls,clientctrls,retoidp,retdatap)
727           DESCRIPTION:
728
729           Perform a synchronous extended operation
730
731           INPUT:
732             ld - LDAP Session Handle
733             requestoid - String
734             requestdata - Binary String
735             serverctrls - LDAP Control List Pointer
736             clientctrls - LDAP Control List Pointer
737             retoidp - String
738
739           OUTPUT:
740             status - Integer
741             retoidp - Return OID
742             retdatap - Return Data
743
744           AVAILABILITY: V3
745
746           EXAMPLE:
747
748             $status = ldap_extended_operation_s($ld,$requestoid,$requestdata,$serverctrls,$clientctrls,$retoidp,$retdatap);
749
750       ldap_first_attribute(ld,entry,ber)
751           DESCRIPTION:
752
753           Return the first attribute returned for a LDAP entry
754
755           INPUT:
756             ld - LDAP Session Handle
757             entry - LDAP Message Pointer
758             ber - Ber Element Pointer
759
760           OUTPUT:
761             status - String
762             ber - Ber Element Pointer
763
764           AVAILABILITY: V2/V3
765
766           EXAMPLE:
767
768             $status = ldap_first_attribute($ld,$entry,$ber);
769
770       ldap_first_entry(ld,chain)
771           DESCRIPTION:
772
773           Return the first entry in a LDAP result chain
774
775           INPUT:
776             ld - LDAP Session Handle
777             chain - LDAP Message Pointer
778
779           OUTPUT:
780             status - LDAP Message Pointer
781
782           AVAILABILITY: V2/V3
783
784           EXAMPLE:
785
786             $status = ldap_first_entry($ld,$chain);
787
788       ldap_first_message(ld,res)
789           DESCRIPTION:
790
791           Return the first message in a LDAP result
792
793           INPUT:
794             ld - LDAP Session Handle
795             res - LDAP Message Pointer
796
797           OUTPUT:
798             status - LDAP Message Pointer
799
800           AVAILABILITY: V3
801
802           EXAMPLE:
803
804             $status = ldap_first_message($ld,$res);
805
806       ldap_first_reference(ld,res)
807           DESCRIPTION:
808
809           Return the first reference in a LDAP result
810
811           INPUT:
812             ld - LDAP Session Handle
813             res - LDAP Message Pointer
814
815           OUTPUT:
816             status - LDAP Message Pointer
817
818           AVAILABILITY: V3
819
820           EXAMPLE:
821
822             $status = ldap_first_reference($ld,$res);
823
824       ldap_free_friendlymap(map)
825           DESCRIPTION:
826
827           Free a LDAP friendly map pointer
828
829           INPUT:
830             map - Friendly Map Pointer
831
832           OUTPUT:
833             status - NONE
834
835           AVAILABILITY: V2/V3
836
837           EXAMPLE:
838
839             $status = ldap_free_friendlymap($map);
840
841       ldap_free_sort_keylist(sortKeyList)
842           DESCRIPTION:
843
844           Free a LDAP sort key pointer
845
846           INPUT:
847             sortKeyList - Sort Key Pointer
848
849           OUTPUT:
850             status - NONE
851
852           AVAILABILITY: V3
853
854           EXAMPLE:
855
856             $status = ldap_free_sort_keylist($sortKeyList);
857
858       ldap_free_urldesc(ludp)
859           DESCRIPTION:
860
861           Free a LDAP URL description hash reference
862
863           INPUT:
864             ludp - URL Description Hash Reference
865
866           OUTPUT:
867             status - NONE
868
869           AVAILABILITY: V3
870
871           EXAMPLE:
872
873             $status = ldap_free_urldesc($ludp);
874
875       ldap_friendly_name(filename,name,map)
876           DESCRIPTION:
877
878           Create a LDAP friendly name map
879
880           INPUT:
881             filename - String
882             name - String
883             map - Friendly Map Pointer
884
885           OUTPUT:
886             status - String
887
888           AVAILABILITY: V3
889
890           EXAMPLE:
891
892             $status = ldap_friendly_name($filename,$name,$map);
893
894       ldap_get_dn(ld,entry)
895           DESCRIPTION:
896
897           Return the distinguished name for an entry
898
899           INPUT:
900             ld - LDAP Session Handle
901             entry - LDAP Message Pointer
902
903           OUTPUT:
904             status - String
905
906           AVAILABILITY: V2/V3
907
908           EXAMPLE:
909
910             $status = ldap_get_dn($ld,$entry);
911
912       ldap_get_entry_controls(ld,entry,serverctrlsp)
913           DESCRIPTION:
914
915           Return the controls for a LDAP entry
916
917           INPUT:
918             ld - LDAP Session Handle
919             entry - LDAP Message Pointer
920             serverctrlsp - LDAP Control List Pointer
921
922           OUTPUT:
923             status - Integer
924             serverctrlsp - LDAP Control List Pointer
925
926           AVAILABILITY: V3
927
928           EXAMPLE:
929
930             $status = ldap_get_entry_controls($ld,$entry,$serverctrlsp);
931
932       ldap_getfilter_free(lfdp)
933           DESCRIPTION:
934
935           Free a LDAP filter
936
937           INPUT:
938             lfdp - LDAP Filter Description Pointer
939
940           OUTPUT:
941             status - NONE
942
943           AVAILABILITY: V3
944
945           EXAMPLE:
946
947             $status = ldap_getfilter_free($lfdp);
948
949       ldap_getfirstfilter(lfdp,tagpat,value)
950           DESCRIPTION:
951
952           Get the first generated filter
953
954           INPUT:
955             lfdp - LDAP Filter Description Pointer
956             tagpat - String
957
958           OUTPUT:
959             status - LDAP Filter Information Pointer
960
961           AVAILABILITY: V2/V3
962
963           EXAMPLE:
964
965             $status = ldap_getfirstfilter($lfdp,$tagpat,$value);
966
967       ldap_get_lang_values(ld,entry,target,type)
968           DESCRIPTION:
969
970           Get values for an entry
971
972           INPUT:
973             ld - LDAP Session Handle
974             entry - LDAP Message Pointer
975             target - String
976             type - String
977
978           OUTPUT:
979             status - NONE
980
981           AVAILABILITY: V3
982
983           EXAMPLE:
984
985             $status = ldap_get_lang_values($ld,$entry,$target,$type);
986
987       ldap_get_lang_values_len(ld,entry,target,type)
988           DESCRIPTION:
989
990           Get binary values for an entry
991
992           INPUT:
993             ld - LDAP Session Handle
994             entry - LDAP Message Pointer
995             target - String
996             type - String
997
998           OUTPUT:
999             status - NONE
1000
1001           AVAILABILITY: V3
1002
1003           EXAMPLE:
1004
1005             $status = ldap_get_lang_values_len($ld,$entry,$target,$type);
1006
1007       ldap_get_lderrno(ld,m,s)
1008           DESCRIPTION:
1009
1010           INPUT:
1011             ld - LDAP Session Handle
1012             m  - String Reference (or undef)
1013             s  - String Reference (or undef)
1014
1015           OUTPUT:
1016             status - Integer
1017
1018           AVAILABILITY: V2/V3
1019
1020           EXAMPLE:
1021
1022             $status = ldap_get_lderrno($ld,\$m,\$s);
1023
1024       ldap_getnextfilter(lfdp)
1025           DESCRIPTION:
1026
1027           Get the next generated LDAP filter
1028
1029           INPUT:
1030             lfdp - LDAP Filter Information Pointer
1031
1032           OUTPUT:
1033             status - LDAP Filter Information Pointer
1034
1035           AVAILABILITY: V2/V3
1036
1037           EXAMPLE:
1038
1039             $status = ldap_getnextfilter($lfdp);
1040
1041       ldap_get_option(ld,option,optdata)
1042           DESCRIPTION:
1043
1044           Get an option for a LDAP session
1045
1046           INPUT:
1047             ld - LDAP Session Handle
1048             option - Integer
1049             optdata - Integer
1050
1051           OUTPUT:
1052             status - Integer
1053             optdata - Integer
1054
1055           AVAILABILITY: V2/V3
1056
1057           EXAMPLE:
1058
1059             $status = ldap_get_option($ld,$option,$optdata);
1060
1061       ldap_get_values(ld,entry,target)
1062           DESCRIPTION:
1063
1064           Get the values for a LDAP entry and attribute
1065
1066           INPUT:
1067             ld - LDAP Session Handle
1068             entry - LDAP Message Pointer
1069             target - String
1070
1071           OUTPUT:
1072             status - NONE
1073
1074           AVAILABILITY: V3
1075
1076           EXAMPLE:
1077
1078             $status = ldap_get_values($ld,$entry,$target);
1079
1080       ldap_get_values_len(ld,entry,target)
1081           DESCRIPTION:
1082
1083           Get the binary values for a LDAP entry and attribute
1084
1085           INPUT:
1086             ld - LDAP Session Handle
1087             entry - LDAP Message Pointer
1088             target - String
1089
1090           OUTPUT:
1091             status - NONE
1092
1093           AVAILABILITY: V3
1094
1095           EXAMPLE:
1096
1097             $status = ldap_get_values_len($ld,$entry,$target);
1098
1099       ldap_init(host,port)
1100           DESCRIPTION:
1101
1102           Initialize a LDAP session
1103
1104           INPUT:
1105             host - String
1106             port - Integer
1107
1108           OUTPUT:
1109             status - LDAP Session Handle
1110
1111           AVAILABILITY: V2/V3
1112
1113           EXAMPLE:
1114
1115             $status = ldap_init($host,$port);
1116
1117       ldap_init_getfilter(fname)
1118           DESCRIPTION:
1119
1120           Initialize the LDAP filter generation routines to a filename
1121
1122           INPUT:
1123             fname - Filename String
1124
1125           OUTPUT:
1126             status - LDAP Filter Description Pointer
1127
1128           AVAILABILITY: V2/V3
1129
1130           EXAMPLE:
1131
1132             $status = ldap_init_getfilter($fname);
1133
1134       ldap_init_getfilter_buf(buf,buflen)
1135           DESCRIPTION:
1136
1137           Initialize the LDAP filter generation routines to a buffer
1138
1139           INPUT:
1140             buf - String
1141             buflen - Integer
1142
1143           OUTPUT:
1144             status - LDAP Filter Description Pointer
1145
1146           AVAILABILITY: V2/V3
1147
1148           EXAMPLE:
1149
1150             $status = ldap_init_getfilter_buf($buf,$buflen);
1151
1152       ldap_is_ldap_url(url)
1153           DESCRIPTION:
1154
1155           Return 1 if an the argument is a valid LDAP URL
1156
1157           INPUT:
1158             url - String
1159
1160           OUTPUT:
1161             status - Integer
1162
1163           AVAILABILITY: V2/V3
1164
1165           EXAMPLE:
1166
1167             $status = ldap_is_ldap_url($url);
1168
1169       ldap_memcache_destroy(cache)
1170           DESCRIPTION:
1171
1172           Destroy a memory cache
1173
1174           INPUT:
1175             cache - LDAP Memory Cache Pointer
1176
1177           OUTPUT:
1178             status - NONE
1179
1180           AVAILABILITY: V3
1181
1182           EXAMPLE:
1183
1184             $status = ldap_memcache_destroy($cache);
1185
1186       ldap_memcache_flush(cache,dn,scope)
1187           DESCRIPTION:
1188
1189           Flush a specific DN from the memory cache
1190
1191           INPUT:
1192             cache - LDAP Memory Cache Pointer
1193             dn - String
1194             scope - Integer
1195
1196           OUTPUT:
1197             status - NONE
1198
1199           AVAILABILITY: V3
1200
1201           EXAMPLE:
1202
1203             $status = ldap_memcache_flush($cache,$dn,$scope);
1204
1205       ldap_memcache_get(ld,cachep)
1206           DESCRIPTION:
1207
1208           Get the memory cache for a LDAP session
1209
1210           INPUT:
1211             ld - LDAP Session Handle
1212             cachep - LDAP Memory Cache Pointer
1213
1214           OUTPUT:
1215             status - Integer
1216             cachep - LDAP Memory Cache Pointer
1217
1218           AVAILABILITY: V3
1219
1220           EXAMPLE:
1221
1222             $status = ldap_memcache_get($ld,$cachep);
1223
1224       ldap_memcache_init(ttl,size,baseDNs,cachep)
1225           DESCRIPTION:
1226
1227           Initialize a LDAP memory cache
1228
1229           INPUT:
1230             ttl - Integer
1231             size - Integer
1232             baseDNs - List Reference
1233             cachep - LDAP Memory Cache Pointer
1234
1235           OUTPUT:
1236             status - Integer
1237             cachep - LDAP Memory Cache Pointer
1238
1239           AVAILABILITY: V3
1240
1241           EXAMPLE:
1242
1243             $status = ldap_memcache_init($ttl,$size,$baseDNs,$cachep);
1244
1245       ldap_memcache_set(ld,cache)
1246           DESCRIPTION:
1247
1248           Set the LDAP memory cache for the session
1249
1250           INPUT:
1251             ld - LDAP Session Handle
1252             cache - LDAP Memory Cache Pointer
1253
1254           OUTPUT:
1255             status - Integer
1256
1257           AVAILABILITY: V2/V3
1258
1259           EXAMPLE:
1260
1261             $status = ldap_memcache_set($ld,$cache);
1262
1263       ldap_memcache_update(cache)
1264           DESCRIPTION:
1265
1266           Update the specified memory cache
1267
1268           INPUT:
1269             cache - LDAP Memory Cache Pointer
1270
1271           OUTPUT:
1272             status - NONE
1273
1274           AVAILABILITY: V3
1275
1276           EXAMPLE:
1277
1278             $status = ldap_memcache_update($cache);
1279
1280       ldap_memfree(p)
1281           DESCRIPTION:
1282
1283           Free memory allocated by the LDAP C API
1284
1285           INPUT:
1286             p - Pointer
1287
1288           OUTPUT:
1289             status - NONE
1290
1291           AVAILABILITY: V2/V3
1292
1293           EXAMPLE:
1294
1295             $status = ldap_memfree($p);
1296
1297       ldap_modify(ld,dn,mods)
1298           DESCRIPTION:
1299
1300           Asynchronously modify a LDAP entry
1301
1302           INPUT:
1303             ld - LDAP Session Handle
1304             dn - String
1305             mods - LDAP Add/Modify Hash
1306
1307           OUTPUT:
1308             status - Integer
1309
1310           AVAILABILITY: V2/V3
1311
1312           EXAMPLE:
1313
1314             $status = ldap_modify($ld,$dn,$mods);
1315
1316       ldap_modify_ext(ld,dn,mods,serverctrls,clientctrls,msgidp)
1317           DESCRIPTION:
1318
1319           Asynchronously modify a LDAP entry w/ Controls
1320
1321           INPUT:
1322             ld - LDAP Session Handle
1323             dn - String
1324             mods - LDAP Add/Modify Hash
1325             serverctrls - LDAP Control List Pointer
1326             clientctrls - LDAP Control List Pointer
1327             msgidp - Integer
1328
1329           OUTPUT:
1330             status - Integer
1331             msgidp - Integer
1332
1333           AVAILABILITY: V3
1334
1335           EXAMPLE:
1336
1337             $status = ldap_modify_ext($ld,$dn,$mods,$serverctrls,$clientctrls,$msgidp);
1338
1339       ldap_modify_ext_s(ld,dn,mods,serverctrls,clientctrls)
1340           DESCRIPTION:
1341
1342           Synchronously modify a LDAP entry w/ Controls
1343
1344           INPUT:
1345             ld - LDAP Session Handle
1346             dn - String
1347             mods - LDAP Add/Modify Hash
1348             serverctrls - LDAP Control List Pointer
1349             clientctrls - LDAP Control List Pointer
1350
1351           OUTPUT:
1352             status - Integer
1353
1354           AVAILABILITY: V3
1355
1356           EXAMPLE:
1357
1358             $status = ldap_modify_ext_s($ld,$dn,$mods,$serverctrls,$clientctrls);
1359
1360       ldap_modify_s(ld,dn,mods)
1361           DESCRIPTION:
1362
1363           Synchronously modify a LDAP entry
1364
1365           INPUT:
1366             ld - LDAP Session Handle
1367             dn - String
1368             mods - LDAP Add/Modify Hash
1369
1370           OUTPUT:
1371             status - Integer
1372
1373           AVAILABILITY: V2/V3
1374
1375           EXAMPLE:
1376
1377             $status = ldap_modify_s($ld,$dn,$mods);
1378
1379       ldap_modrdn(ld,dn,newrdn)
1380           DESCRIPTION:
1381
1382           Asynchronously modify the relative distinguished name of an entry
1383
1384           INPUT:
1385             ld - LDAP Session Handle
1386             dn - String
1387             newrdn - String
1388
1389           OUTPUT:
1390             status - Integer
1391
1392           AVAILABILITY: V2/V3
1393
1394           EXAMPLE:
1395
1396             $status = ldap_modrdn($ld,$dn,$newrdn);
1397
1398       ldap_modrdn_s(ld,dn,newrdn)
1399           DESCRIPTION:
1400
1401           Synchronously modify the relative distinguished name of an entry
1402
1403           INPUT:
1404             ld - LDAP Session Handle
1405             dn - String
1406             newrdn - String
1407
1408           OUTPUT:
1409             status - Integer
1410
1411           AVAILABILITY: V2/V3
1412
1413           EXAMPLE:
1414
1415             $status = ldap_modrdn_s($ld,$dn,$newrdn);
1416
1417       ldap_modrdn2(ld,dn,newrdn,deleteoldrdn)
1418           DESCRIPTION:
1419
1420           Asynchronously modify the relative distinguished name of an entry.
1421
1422           INPUT:
1423             ld - LDAP Session Handle
1424             dn - String
1425             newrdn - String
1426             deleteoldrdn - Integer
1427
1428           OUTPUT:
1429             status - Integer
1430
1431           AVAILABILITY: V2/V3
1432
1433           EXAMPLE:
1434
1435             $status = ldap_modrdn2($ld,$dn,$newrdn,$deleteoldrdn);
1436
1437       ldap_modrdn2_s(ld,dn,newrdn,deleteoldrdn)
1438           DESCRIPTION:
1439
1440           Synchronously modify the relative distinguished name of an entry.
1441
1442           INPUT:
1443             ld - LDAP Session Handle
1444             dn - String
1445             newrdn - String
1446             deleteoldrdn - Integer
1447
1448           OUTPUT:
1449             status - Integer
1450
1451           AVAILABILITY: V2/V3
1452
1453           EXAMPLE:
1454
1455             $status = ldap_modrdn2_s($ld,$dn,$newrdn,$deleteoldrdn);
1456
1457       ldap_msgfree(lm)
1458           DESCRIPTION:
1459
1460           Free memory allocated by a LDAP Message
1461
1462           INPUT:
1463             lm - LDAP Message Pointer
1464
1465           OUTPUT:
1466             status - Integer
1467
1468           AVAILABILITY: V2/V3
1469
1470           EXAMPLE:
1471
1472             $status = ldap_msgfree($lm);
1473
1474       ldap_msgid(lm)
1475           DESCRIPTION:
1476
1477           Get the message id number from a LDAP message
1478
1479           INPUT:
1480             lm - LDAP Message Pointer
1481
1482           OUTPUT:
1483             status - Integer
1484
1485           AVAILABILITY: V2/V3
1486
1487           EXAMPLE:
1488
1489             $status = ldap_msgid($lm);
1490
1491       ldap_msgtype(lm)
1492           DESCRIPTION:
1493
1494           Get the message type of a LDAP message
1495
1496           INPUT:
1497             lm - LDAP Message Pointer
1498
1499           OUTPUT:
1500             status - Integer
1501
1502           AVAILABILITY: V2/V3
1503
1504           EXAMPLE:
1505
1506             $status = ldap_msgtype($lm);
1507
1508       ldap_multisort_entries(ld,chain,attr)
1509           DESCRIPTION:
1510
1511           Sort entries by multiple keys
1512
1513           INPUT:
1514             ld - LDAP Session Handle
1515             chain - LDAP Message Pointer
1516             attr - List Reference
1517
1518           OUTPUT:
1519             status - Integer
1520             chain - LDAP Message Pointer
1521
1522           AVAILABILITY: V2/V3
1523
1524           EXAMPLE:
1525
1526             $status = ldap_multisort_entries($ld,$chain,$attr);
1527
1528       ldap_next_attribute(ld,entry,ber)
1529           DESCRIPTION:
1530
1531           Get the next attribute for a LDAP entry
1532
1533           INPUT:
1534             ld - LDAP Session Handle
1535             entry - LDAP Message Pointer
1536             ber - Ber Element Pointer
1537
1538           OUTPUT:
1539             status - String
1540             ber - BER Element Pointer
1541
1542           AVAILABILITY: V2/V3
1543
1544           EXAMPLE:
1545
1546             $status = ldap_next_attribute($ld,$entry,$ber);
1547
1548       ldap_next_entry(ld,entry)
1549           DESCRIPTION:
1550
1551           Get the next entry in the result chain
1552
1553           INPUT:
1554             ld - LDAP Session Handle
1555             entry - LDAP Message Pointer
1556
1557           OUTPUT:
1558             status - LDAP Message Pointer
1559
1560           AVAILABILITY: V2/V3
1561
1562           EXAMPLE:
1563
1564             $status = ldap_next_entry($ld,$entry);
1565
1566       ldap_next_message(ld,msg)
1567           DESCRIPTION:
1568
1569           Get the next message in the result chain
1570
1571           INPUT:
1572             ld - LDAP Session Handle
1573             msg - LDAP Message Pointer
1574
1575           OUTPUT:
1576             status - LDAP Message Pointer
1577
1578           AVAILABILITY: V3
1579
1580           EXAMPLE:
1581
1582             $status = ldap_next_message($ld,$msg);
1583
1584       ldap_next_reference(ld,ref)
1585           DESCRIPTION:
1586
1587           Get the next reference in the result chain
1588
1589           INPUT:
1590             ld - LDAP Session Handle
1591             ref - LDAP Message Pointer
1592
1593           OUTPUT:
1594             status - LDAP Message Pointer
1595
1596           AVAILABILITY: V3
1597
1598           EXAMPLE:
1599
1600             $status = ldap_next_reference($ld,$ref);
1601
1602       ldap_parse_entrychange_control(ld,ctrls,chgtypep,prevdnp,chgnumpresentp,chgnump)
1603           DESCRIPTION:
1604
1605           Parse a LDAP entry change control
1606
1607           INPUT:
1608             ld - LDAP Session Handle
1609             ctrls - LDAP Control List Pointer
1610             chgtypep - Integer
1611             prevdnp - String
1612             chgnumpresentp - Integer
1613             chgnump - Integer
1614
1615           OUTPUT:
1616             status - Integer
1617             chgtypep - Integer
1618             prevdnp - String
1619             chgnumpresentp - Integer
1620             chgnump - Integer
1621
1622           AVAILABILITY: V3
1623
1624           EXAMPLE:
1625
1626             $status = ldap_parse_entrychange_control($ld,$ctrls,$chgtypep,$prevdnp,$chgnumpresentp,$chgnump);
1627
1628       ldap_parse_extended_result(ld,res,retoidp,retdatap,freeit)
1629           DESCRIPTION:
1630
1631           Parse a LDAP extended result
1632
1633           INPUT:
1634             ld - LDAP Session Handle
1635             res - LDAP Message Pointer
1636             retoidp - String
1637             freeit - Integer
1638
1639           OUTPUT:
1640             status - Integer
1641             retoidp - String
1642             retdatap - Binary List Reference
1643
1644           AVAILABILITY: V3
1645
1646           EXAMPLE:
1647
1648             $status = ldap_parse_extended_result($ld,$res,$retoidp,$retdatap,$freeit);
1649
1650       ldap_parse_reference(ld,ref,referalsp,serverctrlsp,freeit)
1651           DESCRIPTION:
1652
1653           Parse a LDAP Reference
1654
1655           INPUT:
1656             ld - LDAP Session Handle
1657             ref - LDAP Message Pointer
1658             referalsp - List Reference
1659             serverctrlsp - LDAP Control List Pointer
1660             freeit - Integer
1661
1662           OUTPUT:
1663             status - Integer
1664             referalsp - List Reference
1665             serverctrlsp - LDAP Control List Pointer
1666
1667           AVAILABILITY: V3
1668
1669           EXAMPLE:
1670
1671             $status = ldap_parse_reference($ld,$ref,$referalsp,$serverctrlsp,$freeit);
1672
1673       ldap_parse_result(ld,res,errcodep,matcheddnp,errmsgp,referralsp,serverctrlsp,freeit)
1674           DESCRIPTION:
1675
1676           Parse a LDAP result
1677
1678           INPUT:
1679             ld - LDAP Session Handle
1680             res - LDAP Message Pointer
1681             errcodep - Integer
1682             matcheddnp - String
1683             errmsgp - String
1684             referralsp - List Reference
1685             serverctrlsp - LDAP Control List Pointer
1686             freeit - Integer
1687
1688           OUTPUT:
1689             status - Integer
1690             errcodep - Integer
1691             matcheddnp - String
1692             errmsgp - String
1693             referralsp - List Reference
1694             serverctrlsp - LDAP Control List Pointer
1695
1696           AVAILABILITY: V3
1697
1698           EXAMPLE:
1699
1700             $status = ldap_parse_result($ld,$res,$errcodep,$matcheddnp,$errmsgp,$referralsp,$serverctrlsp,$freeit);
1701
1702       ldap_parse_sasl_bind_result(ld,res,servercredp,freeit)
1703           DESCRIPTION:
1704
1705           Parse the results of an SASL bind operation
1706
1707           INPUT:
1708             ld - LDAP Session Handle
1709             res - LDAP Message Pointer
1710             freeit - Integer
1711
1712           OUTPUT:
1713             status - Integer
1714             servercredp -
1715
1716           AVAILABILITY: V3
1717
1718           EXAMPLE:
1719
1720             $status = ldap_parse_sasl_bind_result($ld,$res,$servercredp,$freeit);
1721
1722       ldap_parse_sort_control(ld,ctrls,result,attribute)
1723           DESCRIPTION:
1724
1725           Parse a LDAP sort control
1726
1727           INPUT:
1728             ld - LDAP Session Handle
1729             ctrls - LDAP Control List Pointer
1730             result - LDAP Message Pointer
1731             attribute - String
1732
1733           OUTPUT:
1734             status - Integer
1735             result - LDAP Message Pointer
1736             attribute - String
1737
1738           AVAILABILITY: V3
1739
1740           EXAMPLE:
1741
1742             $status = ldap_parse_sort_control($ld,$ctrls,$result,$attribute);
1743
1744       ldap_parse_virtuallist_control(ld,ctrls,target_posp,list_sizep,errcodep)
1745           DESCRIPTION:
1746
1747           Parse a LDAP virtual list control
1748
1749           INPUT:
1750             ld - LDAP Session Handle
1751             ctrls - LDAP Control List Pointer
1752             target_posp - Integer
1753             list_sizep - Integer
1754             errcodep - Integer
1755
1756           OUTPUT:
1757             status - Integer
1758             target_posp - Integer
1759             list_sizep - Integer
1760             errcodep - Integer
1761
1762           AVAILABILITY: V3
1763
1764           EXAMPLE:
1765
1766             $status = ldap_parse_virtuallist_control($ld,$ctrls,$target_posp,$list_sizep,$errcodep);
1767
1768       ldap_perror(ld,s)
1769           DESCRIPTION:
1770
1771           Print a LDAP error message
1772
1773           INPUT:
1774             ld - LDAP Session Handle
1775             s - String
1776
1777           OUTPUT:
1778             status - NONE
1779
1780           AVAILABILITY: V2/V3
1781
1782           EXAMPLE:
1783
1784             $status = ldap_perror($ld,$s);
1785
1786       ldap_rename(ld,dn,newrdn,newparent,deleteoldrdn,serverctrls,clientctrls,msgidp)
1787           DESCRIPTION:
1788
1789           Asynchronously rename a LDAP entry
1790
1791           INPUT:
1792             ld - LDAP Session Handle
1793             dn - String
1794             newrdn - String
1795             newparent - String
1796             deleteoldrdn - Integer
1797             serverctrls - LDAP Control List Pointer
1798             clientctrls - LDAP Control List Pointer
1799             msgidp - Integer
1800
1801           OUTPUT:
1802             status - Integer
1803             msgidp - Integer
1804
1805           AVAILABILITY: V3
1806
1807           EXAMPLE:
1808
1809             $status = ldap_rename($ld,$dn,$newrdn,$newparent,$deleteoldrdn,$serverctrls,$clientctrls,$msgidp);
1810
1811       ldap_rename_s(ld,dn,newrdn,newparent,deleteoldrdn,serverctrls,clientctrls)
1812           DESCRIPTION:
1813
1814           Synchronously rename a LDAP entry
1815
1816           INPUT:
1817             ld - LDAP Session Handle
1818             dn - String
1819             newrdn - String
1820             newparent - String
1821             deleteoldrdn - Integer
1822             serverctrls - LDAP Control List Pointer
1823             clientctrls - LDAP Control List Pointer
1824
1825           OUTPUT:
1826             status - Integer
1827
1828           AVAILABILITY: V3
1829
1830           EXAMPLE:
1831
1832             $status = ldap_rename_s($ld,$dn,$newrdn,$newparent,$deleteoldrdn,$serverctrls,$clientctrls);
1833
1834       ldap_result(ld,msgid,all,timeout,result)
1835           DESCRIPTION:
1836
1837           Get the result for an asynchronous LDAP operation
1838
1839           INPUT:
1840             ld - LDAP Session Handle
1841             msgid - Integer
1842             all - Integer
1843             timeout - Time in Seconds
1844             result - LDAP Message Pointer
1845
1846           OUTPUT:
1847             status - Integer
1848             result - LDAP Message Pointer
1849
1850           AVAILABILITY: V2/V3
1851
1852           EXAMPLE:
1853
1854             $status = ldap_result($ld,$msgid,$all,$timeout,$result);
1855
1856       ldap_result2error(ld,r,freeit)
1857           DESCRIPTION:
1858
1859           Get the error number for a given result
1860
1861           INPUT:
1862             ld - LDAP Session Handle
1863             r - LDAP Message Pointer
1864             freeit - Integer
1865
1866           OUTPUT:
1867             status - Integer
1868
1869           AVAILABILITY: V2/V3
1870
1871           EXAMPLE:
1872
1873             $status = ldap_result2error($ld,$r,$freeit);
1874
1875       ldap_sasl_bind(ld,dn,mechanism,cred,serverctrls,clientctrls,msgidp)
1876           DESCRIPTION:
1877
1878           Asynchronously bind to the LDAP server using a SASL mechanism
1879
1880           INPUT:
1881             ld - LDAP Session Handle
1882             dn - String
1883             mechanism - String
1884             cred - Binary String
1885             serverctrls - LDAP Control List Pointer
1886             clientctrls - LDAP Control List Pointer
1887             msgidp - Integer
1888
1889           OUTPUT:
1890             status - Integer
1891             msgidp - Integer
1892
1893           AVAILABILITY: V3
1894
1895           EXAMPLE:
1896
1897             $status = ldap_sasl_bind($ld,$dn,$mechanism,$cred,$serverctrls,$clientctrls,$msgidp);
1898
1899       ldap_sasl_bind_s(ld,dn,mechanism,cred,serverctrls,clientctrls,servercredp)
1900           DESCRIPTION:
1901
1902           Synchronously bind to a LDAP server using a SASL mechanism
1903
1904           INPUT:
1905             ld - LDAP Session Handle
1906             dn - String
1907             mechanism - String
1908             cred - Binary String
1909             serverctrls - LDAP Control List Pointer
1910             clientctrls - LDAP Control List Pointer
1911
1912           OUTPUT:
1913             status - Integer
1914             servercredp -
1915
1916           AVAILABILITY: V3
1917
1918           EXAMPLE:
1919
1920             $status = ldap_sasl_bind_s($ld,$dn,$mechanism,$cred,$serverctrls,$clientctrls,$servercredp);
1921
1922       ldap_search(ld,base,scope,filter,attrs,attrsonly)
1923           DESCRIPTION:
1924
1925           Asynchronously search the LDAP server
1926
1927           INPUT:
1928             ld - LDAP Session Handle
1929             base - String
1930             scope - Integer
1931             filter - String
1932             attrs - List Reference
1933             attrsonly - Integer
1934
1935           OUTPUT:
1936             status - Integer
1937
1938           AVAILABILITY: V2/V3
1939
1940           EXAMPLE:
1941
1942             $status = ldap_search($ld,$base,$scope,$filter,$attrs,$attrsonly);
1943
1944       ldap_search_ext(ld,base,scope,filter,attrs,attrsonly,serverctrls,clientctrls,timeoutp,sizelimit,msgidp)
1945           DESCRIPTION:
1946
1947           Asynchronously search the LDAP server w/ Controls
1948
1949           INPUT:
1950             ld - LDAP Session Handle
1951             base - String
1952             scope - Integer
1953             filter - String
1954             attrs - List Reference
1955             attrsonly - Integer
1956             serverctrls - LDAP Control List Pointer
1957             clientctrls - LDAP Control List Pointer
1958             timeoutp - Time in Seconds
1959             sizelimit - Integer
1960             msgidp - Integer
1961
1962           OUTPUT:
1963             status - Integer
1964             msgidp - Integer
1965
1966           AVAILABILITY: V3
1967
1968           EXAMPLE:
1969
1970             $status = ldap_search_ext($ld,$base,$scope,$filter,$attrs,$attrsonly,$serverctrls,$clientctrls,$timeoutp,$sizelimit,$msgidp);
1971
1972       ldap_search_ext_s(ld,base,scope,filter,attrs,attrsonly,serverctrls,clientctrls,timeoutp,sizelimit,res)
1973           DESCRIPTION:
1974
1975           Synchronously search the LDAP server w/ Controls
1976
1977           INPUT:
1978             ld - LDAP Session Handle
1979             base - String
1980             scope - Integer
1981             filter - String
1982             attrs - List Reference
1983             attrsonly - Integer
1984             serverctrls - LDAP Control List Pointer
1985             clientctrls - LDAP Control List Pointer
1986             timeoutp - Time in Seconds
1987             sizelimit - Integer
1988             res - LDAP Message Pointer
1989
1990           OUTPUT:
1991             status - Integer
1992             res - LDAP Message Pointer
1993
1994           AVAILABILITY: V3
1995
1996           EXAMPLE:
1997
1998             $status = ldap_search_ext_s($ld,$base,$scope,$filter,$attrs,$attrsonly,$serverctrls,$clientctrls,$timeoutp,$sizelimit,$res);
1999
2000       ldap_search_s(ld,base,scope,filter,attrs,attrsonly,res)
2001           DESCRIPTION:
2002
2003           Synchronously search the LDAP server
2004
2005           INPUT:
2006             ld - LDAP Session Handle
2007             base - String
2008             scope - Integer
2009             filter - String
2010             attrs - List Reference
2011             attrsonly - Integer
2012             res - LDAP Message Pointer
2013
2014           OUTPUT:
2015             status - Integer
2016             res - LDAP Message Pointer
2017
2018           AVAILABILITY: V2/V3
2019
2020           EXAMPLE:
2021
2022             $status = ldap_search_s($ld,$base,$scope,$filter,$attrs,$attrsonly,$res);
2023
2024       ldap_search_st(ld,base,scope,filter,attrs,attrsonly,timeout,res)
2025           DESCRIPTION:
2026
2027           Synchronously search the LDAP server w/ Timeout
2028
2029           INPUT:
2030             ld - LDAP Session Handle
2031             base - String
2032             scope - Integer
2033             filter - String
2034             attrs - List Reference
2035             attrsonly - Integer
2036             timeout - Time in Seconds
2037             res - LDAP Message Pointer
2038
2039           OUTPUT:
2040             status - Integer
2041             res - LDAP Message Pointer
2042
2043           AVAILABILITY: V2/V3
2044
2045           EXAMPLE:
2046
2047             $status = ldap_search_st($ld,$base,$scope,$filter,$attrs,$attrsonly,$timeout,$res);
2048
2049       ldap_set_filter_additions(lfdp,prefix,suffix)
2050           DESCRIPTION:
2051
2052           Add a prefix and suffix for filter generation
2053
2054           INPUT:
2055             lfdp - LDAP Filter Description Pointer
2056             prefix - String
2057             suffix - String
2058
2059           OUTPUT:
2060             status - Integer
2061
2062           AVAILABILITY: V2/V3
2063
2064           EXAMPLE:
2065
2066             $status = ldap_set_filter_additions($lfdp,$prefix,$suffix);
2067
2068       ldap_set_lderrno(ld,e,m,s)
2069           DESCRIPTION:
2070
2071           Set the LDAP error structure
2072
2073           INPUT:
2074             ld - LDAP Session Handle
2075             e - Integer
2076             m - String
2077             s - String
2078
2079           OUTPUT:
2080             status - Integer
2081
2082           AVAILABILITY: V2/V3
2083
2084           EXAMPLE:
2085
2086             $status = ldap_set_lderrno($ld,$e,$m,$s);
2087
2088       ldap_set_option(ld,option,optdata)
2089           DESCRIPTION:
2090
2091           Set a LDAP session option
2092
2093           INPUT:
2094             ld - LDAP Session Handle
2095             option - Integer
2096             optdata - Integer
2097
2098           OUTPUT:
2099             status - Integer
2100
2101           AVAILABILITY: V2/V3
2102
2103           EXAMPLE:
2104
2105             $status = ldap_set_option($ld,$option,$optdata);
2106
2107       ldap_set_rebind_proc(ld,rebindproc)
2108           DESCRIPTION:
2109
2110           Set the LDAP rebind process
2111
2112           INPUT:
2113             ld - LDAP Session Handle
2114
2115           OUTPUT:
2116             status - NONE
2117
2118           AVAILABILITY: V2/V3
2119
2120           EXAMPLE:
2121
2122             $status = ldap_set_rebind_proc($ld,$rebindproc);
2123
2124       ldap_simple_bind(ld,who,passwd)
2125           DESCRIPTION:
2126
2127           Asynchronously bind to the LDAP server using simple authentication
2128
2129           INPUT:
2130             ld - LDAP Session Handle
2131             who - String
2132             passwd - String
2133
2134           OUTPUT:
2135             status - Integer
2136
2137           AVAILABILITY: V2/V3
2138
2139           EXAMPLE:
2140
2141             $status = ldap_simple_bind($ld,$who,$passwd);
2142
2143       ldap_simple_bind_s(ld,who,passwd)
2144           DESCRIPTION:
2145
2146           Synchronously bind to the LDAP server using simple authentication
2147
2148           INPUT:
2149             ld - LDAP Session Handle
2150             who - String
2151             passwd - String
2152
2153           OUTPUT:
2154             status - Integer
2155
2156           AVAILABILITY: V2/V3
2157
2158           EXAMPLE:
2159
2160             $status = ldap_simple_bind_s($ld,$who,$passwd);
2161
2162       ldap_sort_entries(ld,chain,attr)
2163           DESCRIPTION:
2164
2165           Sort the results of a LDAP search
2166
2167           INPUT:
2168             ld - LDAP Session Handle
2169             chain - LDAP Message Pointer
2170             attr - String
2171
2172           OUTPUT:
2173             status - Integer
2174             chain - LDAP Message Pointer
2175
2176           AVAILABILITY: V2/V3
2177
2178           EXAMPLE:
2179
2180             $status = ldap_sort_entries($ld,$chain,$attr);
2181
2182       ldap_unbind(ld)
2183           DESCRIPTION:
2184
2185           Asynchronously unbind from the LDAP server
2186
2187           INPUT:
2188             ld - LDAP Session Handle
2189
2190           OUTPUT:
2191             status - Integer
2192
2193           AVAILABILITY: V2/V3
2194
2195           EXAMPLE:
2196
2197             $status = ldap_unbind($ld);
2198
2199       ldap_unbind_s(ld)
2200           DESCRIPTION:
2201
2202           Synchronously unbind from a LDAP server
2203
2204           INPUT:
2205             ld - LDAP Session Handle
2206
2207           OUTPUT:
2208             status - Integer
2209
2210           AVAILABILITY: V2/V3
2211
2212           EXAMPLE:
2213
2214             $status = ldap_unbind_s($ld);
2215
2216       ldap_url_parse(url)
2217           DESCRIPTION:
2218
2219           Parse a LDAP URL, returning a HASH of its components
2220
2221           INPUT:
2222             url - String
2223
2224           OUTPUT:
2225             status -
2226
2227           AVAILABILITY: V2/V3
2228
2229           EXAMPLE:
2230
2231             $status = ldap_url_parse($url);
2232
2233       ldap_url_search(ld,url,attrsonly)
2234           DESCRIPTION:
2235
2236           Asynchronously search using a LDAP URL
2237
2238           INPUT:
2239             ld - LDAP Session Handle
2240             url - String
2241             attrsonly - Integer
2242
2243           OUTPUT:
2244             status - Integer
2245
2246           AVAILABILITY: V2/V3
2247
2248           EXAMPLE:
2249
2250             $status = ldap_url_search($ld,$url,$attrsonly);
2251
2252       ldap_url_search_s(ld,url,attrsonly,res)
2253           DESCRIPTION:
2254
2255           Synchronously search using a LDAP URL
2256
2257           INPUT:
2258             ld - LDAP Session Handle
2259             url - String
2260             attrsonly - Integer
2261             res - LDAP Message Pointer
2262
2263           OUTPUT:
2264             status - Integer
2265             res - LDAP Message Pointer
2266
2267           AVAILABILITY: V2/V3
2268
2269           EXAMPLE:
2270
2271             $status = ldap_url_search_s($ld,$url,$attrsonly,$res);
2272
2273       ldap_url_search_st(ld,url,attrsonly,timeout,res)
2274           DESCRIPTION:
2275
2276           Synchronously search using a LDAP URL w/ timeout
2277
2278           INPUT:
2279             ld - LDAP Session Handle
2280             url - String
2281             attrsonly - Integer
2282             timeout - Time in Seconds
2283             res - LDAP Message Pointer
2284
2285           OUTPUT:
2286             status - Integer
2287             res - LDAP Message Pointer
2288
2289           AVAILABILITY: V2/V3
2290
2291           EXAMPLE:
2292
2293             $status = ldap_url_search_st($ld,$url,$attrsonly,$timeout,$res);
2294
2295       prldap_install_routines(ld,shared)
2296           DESCRIPTION:
2297
2298           Install NSPR I/O, threading, and DNS functions so they can be used
2299           by the LDAP connection (ld).
2300
2301           If 'ld' is NULL, the functions are installed as the default
2302           functions for all new LDAP * handles).
2303
2304           INPUT:
2305             ld - LDAP Session Handle
2306             shared - True if the LDAP * handle is used in an MT context
2307
2308           OUTPUT:
2309             status - Integer
2310
2311           AVAILABILITY: V3
2312

CREDITS

2314       Most of the Perl API module was written by Clayton Donley to interface
2315       with C API routines from Netscape Communications Corp., Inc.
2316

BUGS

2318       Documentation needs much work.  LDAPv3 calls not tested or supported in
2319       this version.  NT can not use Perl Rebind processes, must use
2320       'ldap_set_default_rebindproc'.  Possible memory leak in ldap_search* is
2321       being investigated.
2322

POD ERRORS

2327       Hey! The above document had some coding errors, which are explained
2328       below:
2329
2330       Around line 500:
2331           '=item' outside of any '=over'
2332
2333       Around line 2959:
2334           You forgot a '=back' before '=head1'
2335
2336
2337
2338perl v5.30.1                      2020-01-30                            API(3)