NAME

ldap_search, ldap_search_s, ldap_search_st, ldap_search_ext, ldap_search_ext_s - Perform an LDAP search operation

LIBRARY

OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS


##iinncclluuddee <>
##iinncclluuddee <>
<>
<>
iinntt llddaapp__sseeaarrcchh__eexxtt((
LLDDAAPP **_l_d,,
cchhaarr **_b_a_s_e,,
iinntt _s_c_o_p_e,,
cchhaarr **_f_i_l_t_e_r,,
cchhaarr **_a_t_t_r_s[[]],,
iinntt _a_t_t_r_s_o_n_l_y,,
LLDDAAPPCCoonnttrrooll ****_s_e_r_v_e_r_c_t_r_l_s,,
LLDDAAPPCCoonnttrrooll ****_c_l_i_e_n_t_c_t_r_l_s,,
ssttrruucctt ttiimmeevvaall **_t_i_m_e_o_u_t,,
iinntt _s_i_z_e_l_i_m_i_t,,
iinntt **_m_s_g_i_d_p ));;
<>
iinntt llddaapp__sseeaarrcchh__eexxtt__ss((
LLDDAAPP **_l_d,,
cchhaarr **_b_a_s_e,,
iinntt _s_c_o_p_e,,
cchhaarr **_f_i_l_t_e_r,,
cchhaarr **_a_t_t_r_s[[]],,
iinntt _a_t_t_r_s_o_n_l_y,,
LLDDAAPPCCoonnttrrooll ****_s_e_r_v_e_r_c_t_r_l_s,,
LLDDAAPPCCoonnttrrooll ****_c_l_i_e_n_t_c_t_r_l_s,,
ssttrruucctt ttiimmeevvaall **_t_i_m_e_o_u_t,,
iinntt _s_i_z_e_l_i_m_i_t,,
LLDDAAPPMMeessssaaggee ****_r_e_s ));;
<> DDEESSCCRRIIPPTTIIOONN <>
TThheessee rroouuttiinneess aarree uusseedd ttoo ppeerrffoorrmm LLDDAAPP sseeaarrcchh ooppeerraattiioonnss..
TThhee
<>llddaapp__sseeaarrcchh__eexxtt__ss(())<>
rroouuttiinnee
ddooeess tthhee sseeaarrcchh ssyynncchhrroonnoouussllyy ((ii..ee..,, nnoott
rreettuurrnniinngg uunnttiill tthhee ooppeerraattiioonn ccoommpplleetteess)),, pprroovviiddiinngg aa ppooiinntteerr
ttoo tthhee rreessuullttiinngg LLDDAAPP mmeessssaaggeess aatt tthhee llooccaattiioonn ppooiinntteedd ttoo bbyy
tthhee _r_e_s ppaarraammeetteerr..
<>
TThhee
<>llddaapp__sseeaarrcchh__eexxtt(())<>
rroouuttiinnee iiss tthhee aassyynncchhrroonnoouuss vveerrssiioonn,, iinniittiiaattiinngg tthhee sseeaarrcchh aanndd rreettuurrnniinngg
tthhee mmeessssaaggee iidd ooff tthhee ooppeerraattiioonn iitt iinniittiiaatteedd iinn tthhee iinntteeggeerr
ppooiinntteedd ttoo bbyy tthhee _m_s_g_i_d_p ppaarraammeetteerr..
<>
TThhee _b_a_s_e ppaarraammeetteerr iiss tthhee DDNN ooff tthhee eennttrryy aatt wwhhiicchh ttoo ssttaarrtt tthhee sseeaarrcchh..
<>
TThhee _s_c_o_p_e ppaarraammeetteerr iiss tthhee ssccooppee ooff tthhee sseeaarrcchh aanndd sshhoouulldd bbee oonnee
ooff LLDDAAPP__SSCCOOPPEE__BBAASSEE,, ttoo sseeaarrcchh tthhee oobbjjeecctt iittsseellff,, LLDDAAPP__SSCCOOPPEE__OONNEELLEEVVEELL,,
ttoo sseeaarrcchh tthhee oobbjjeecctt''ss iimmmmeeddiiaattee cchhiillddrreenn,, LLDDAAPP__SSCCOOPPEE__SSUUBBTTRREEEE,, ttoo
sseeaarrcchh tthhee oobbjjeecctt aanndd aallll iittss ddeesscceennddaannttss,, oorr LLDDAAPP__SSCCOOPPEE__CCHHIILLDDRREENN,,
ttoo sseeaarrcchh aallll ooff tthhee ddeesscceennddaannttss..   NNoottee tthhaatt tthhee llaatttteerr rreeqquuiirreess
tthhee sseerrvveerr ssuuppppoorrtt tthhee LLDDAAPP SSuubboorrddiinnaatteess SSeeaarrcchh SSccooppee eexxtteennssiioonn..
<>
TThhee _f_i_l_t_e_r iiss aa ssttrriinngg rreepprreesseennttaattiioonn ooff tthhee ffiilltteerr ttoo
aappppllyy iinn tthhee sseeaarrcchh..  TThhee ssttrriinngg sshhoouulldd ccoonnffoorrmm ttoo tthhee ffoorrmmaatt
ssppeecciiffiieedd iinn RRFFCC 44551155 aass eexxtteennddeedd bbyy RRFFCC 44552266..  FFoorr iinnssttaannccee,,
""((ccnn==JJaannee DDooee))""..  NNoottee tthhaatt uussee ooff tthhee eexxtteennssiioonn rreeqquuiirreess tthhee
sseerrvveerr ttoo ssuuppppoorrtt tthhee LLDDAAPP AAbbssoolluuttee TTrruuee//FFaallssee FFiilltteerr eexxtteennssiioonn..
NNUULLLL mmaayy bbee ssppeecciiffiieedd ttoo iinnddiiccaattee tthhee lliibbrraarryy sshhoouulldd sseenndd tthhee
ffiilltteerr ((oobbjjeeccttCCllaassss==**))..
<>
TThhee _a_t_t_r_s ppaarraammeetteerr iiss aa nnuullll--tteerrmmiinnaatteedd aarrrraayy ooff aattttrriibbuuttee
ddeessccrriippttiioonnss ttoo rreettuurrnn ffrroomm mmaattcchhiinngg eennttrriieess..
IIff NNUULLLL iiss ssppeecciiffiieedd,, tthhee rreettuurrnn ooff aallll uusseerr aattttrriibbuutteess iiss rreeqquueesstteedd..
TThhee ddeessccrriippttiioonn ""**"" ((LLDDAAPP__AALLLL__UUSSEERR__AATTTTRRIIBBUUTTEESS)) mmaayy bbee uusseedd ttoo rreeqquueesstt
aallll uusseerr aattttrriibbuutteess ttoo bbee rreettuurrnneedd..
TThhee ddeessccrriippttiioonn ""++""((LLDDAAPP__AALLLL__OOPPEERRAATTIIOONNAALL__AATTTTRRIIBBUUTTEESS)) mmaayy bbee uusseedd ttoo
rreeqquueesstt aallll ooppeerraattiioonnaall aattttrriibbuutteess ttoo bbee rreettuurrnneedd..  NNoottee tthhaatt tthhiiss
rreeqquuiirreess tthhee sseerrvveerr ttoo ssuuppppoorrtt tthhee LLDDAAPP AAllll OOppeerraattiioonnaall AAttttrriibbuuttee
eexxtteennssiioonn..
TToo rreeqquueesstt nnoo aattttrriibbuutteess,, tthhee ddeessccrriippttiioonn ""11..11"" ((LLDDAAPP__NNOO__AATTTTRRSS))
sshhoouulldd bbee lliisstteedd bbyy iittsseellff..
<>
TThhee _a_t_t_r_s_o_n_l_y ppaarraammeetteerr sshhoouulldd bbee sseett ttoo aa nnoonn--zzeerroo vvaalluuee
iiff oonnllyy aattttrriibbuuttee ddeessccrriippttiioonnss aarree wwaanntteedd..  IItt sshhoouulldd bbee sseett ttoo zzeerroo ((00))
iiff bbootthh aattttrriibbuutteess ddeessccrriippttiioonnss aanndd aattttrriibbuuttee vvaalluueess aarree wwaanntteedd..
<>
TThhee _s_e_r_v_e_r_c_t_r_l_s aanndd _c_l_i_e_n_t_c_t_r_l_s ppaarraammeetteerrss mmaayy bbee uusseedd
ttoo ssppeecciiffyy sseerrvveerr aanndd cclliieenntt ccoonnttrroollss,, rreessppeeccttiivveellyy..
<>
TThhee
<>llddaapp__sseeaarrcchh__eexxtt__ss(())<>
rroouuttiinnee iiss tthhee ssyynncchhrroonnoouuss vveerrssiioonn ooff
llddaapp__sseeaarrcchh__eexxtt(())..
<>
IItt aallssoo rreettuurrnnss aa ccooddee iinnddiiccaattiinngg ssuucccceessss oorr,, iinn tthhee
ccaassee ooff ffaaiilluurree,, iinnddiiccaattiinngg tthhee nnaattuurree ooff tthhee ffaaiilluurree
ooff tthhee ooppeerraattiioonn..  SSeeee
<>llddaapp__eerrrroorr((33))<>
ffoorr ddeettaaiillss..
<> NNOOTTEESS <>
NNoottee tthhaatt bbootthh rreeaadd
aanndd lliisstt ffuunnccttiioonnaalliittyy aarree ssuubbssuummeedd bbyy tthheessee rroouuttiinneess,,
bbyy uussiinngg aa ffiilltteerr lliikkee ""((oobbjjeeccttccllaassss==**))"" aanndd aa ssccooppee ooff LLDDAAPP__SSCCOOPPEE__BBAASSEE ((ttoo
eemmuullaattee rreeaadd)) oorr LLDDAAPP__SSCCOOPPEE__OONNEELLEEVVEELL ((ttoo eemmuullaattee lliisstt))..
<>
TThheessee rroouuttiinneess mmaayy ddyynnaammiiccaallllyy aallllooccaattee mmeemmoorryy.. TThhee ccaalllleerr iiss
rreessppoonnssiibbllee ffoorr ffrreeeeiinngg ssuucchh mmeemmoorryy uussiinngg ssuupppplliieedd ddeeaallllooccaattiioonn
rroouuttiinneess.. RReettuurrnn vvaalluueess aarree ccoonnttaaiinneedd iinn <>..
<> DDEEPPRREECCAATTEEDD IINNTTEERRFFAACCEESS <>
TThhee
<>llddaapp__sseeaarrcchh(())<>
rroouuttiinnee iiss ddeepprreeccaatteedd iinn ffaavvoorr ooff tthhee
<>llddaapp__sseeaarrcchh__eexxtt(())<>
rroouuttiinnee..  TThhee
<>llddaapp__sseeaarrcchh__ss(())<>
aanndd
<>llddaapp__sseeaarrcchh__sstt(())<>
rroouuttiinneess aarree ddeepprreeccaatteedd iinn ffaavvoorr ooff tthhee
<>llddaapp__sseeaarrcchh__eexxtt__ss(())<>
rroouuttiinnee..
<>
DDeepprreeccaatteedd iinntteerrffaacceess ggeenneerraallllyy rreemmaaiinn iinn tthhee lliibbrraarryy..  TThhee mmaaccrroo
LLDDAAPP__DDEEPPRREECCAATTEEDD ccaann bbee ddeeffiinneedd ttoo aa nnoonn--zzeerroo vvaalluuee
((ee..gg..,, --DDLLDDAAPP__DDEEPPRREECCAATTEEDD==11)) wwhheenn ccoommppiilliinngg pprrooggrraamm ddeessiiggnneedd ttoo uussee
ddeepprreeccaatteedd iinntteerrffaacceess..  IItt iiss rreeccoommmmeennddeedd tthhaatt ddeevveellooppeerrss wwrriittiinngg nneeww
pprrooggrraammss,, oorr uuppddaattiinngg oolldd pprrooggrraammss,, aavvooiidd uussee ooff ddeepprreeccaatteedd iinntteerrffaacceess..
OOvveerr ttiimmee,, iitt iiss eexxppeecctteedd tthhaatt ddooccuummeennttaattiioonn ((aanndd,, eevveennttuuaallllyy,, ssuuppppoorrtt)) ffoorr
ddeepprreeccaatteedd iinntteerrffaacceess ttoo bbee eelliimmiinnaatteedd..
<> SSEEEE AALLSSOO <>
<>llddaapp((33))<>
<>llddaapp__rreessuulltt((33))<>
<>llddaapp__eerrrroorr((33))<>
<> AACCKKNNOOWWLLEEDDGGEEMMEENNTTSS <>
<>OOppeennLLDDAAPP SSooffttwwaarree<>
iiss ddeevveellooppeedd aanndd mmaaiinnttaaiinneedd bbyy TThhee OOppeennLLDDAAPP PPrroojjeecctt <>..
<>OOppeennLLDDAAPP SSooffttwwaarree<>
iiss ddeerriivveedd ffrroomm UUnniivveerrssiittyy ooff MMiicchhiiggaann LLDDAAPP 33..33 RReelleeaassee..
<>
<>