NAME

ldap_result - Wait for the result of an LDAP operation

LIBRARY

OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS


##iinncclluuddee <>
<>
<>
iinntt llddaapp__rreessuulltt(( LLDDAAPP **lldd,, iinntt mmssggiidd,, iinntt aallll,,
        ssttrruucctt ttiimmeevvaall **ttiimmeeoouutt,, LLDDAAPPMMeessssaaggee ****rreessuulltt ));;
        <>
iinntt llddaapp__mmssggffrreeee(( LLDDAAPPMMeessssaaggee **mmssgg ));;
        <>
iinntt llddaapp__mmssggttyyppee(( LLDDAAPPMMeessssaaggee **mmssgg ));;
        <>
iinntt llddaapp__mmssggiidd(( LLDDAAPPMMeessssaaggee **mmssgg ));;
<> DDEESSCCRRIIPPTTIIOONN <>
TThhee
<>llddaapp__rreessuulltt(())<>
rroouuttiinnee iiss uusseedd ttoo wwaaiitt ffoorr aanndd rreettuurrnn tthhee rreessuulltt ooff
aann ooppeerraattiioonn pprreevviioouussllyy iinniittiiaatteedd bbyy oonnee ooff tthhee LLDDAAPP aassyynncchhrroonnoouuss
ooppeerraattiioonn rroouuttiinneess ((ee..gg..,,
<>llddaapp__sseeaarrcchh__eexxtt((33))<>
<>llddaapp__mmooddiiffyy__eexxtt((33))<>
eettcc..))..  TThhoossee rroouuttiinneess aallll rreettuurrnn --11 iinn ccaassee ooff eerrrroorr,, aanndd aann
iinnvvooccaattiioonn iiddeennttiiffiieerr uuppoonn ssuucccceessssffuull iinniittiiaattiioonn ooff tthhee ooppeerraattiioonn.. TThhee
iinnvvooccaattiioonn iiddeennttiiffiieerr iiss ppiicckkeedd bbyy tthhee lliibbrraarryy aanndd iiss gguuaarraanntteeeedd ttoo bbee
uunniiqquuee aaccrroossss tthhee LLDDAAPP sseessssiioonn..  IItt ccaann bbee uusseedd ttoo rreeqquueesstt tthhee rreessuulltt
ooff aa ssppeecciiffiicc ooppeerraattiioonn ffrroomm
<>llddaapp__rreessuulltt(())<>
tthhrroouugghh tthhee _m_s_g_i_d ppaarraammeetteerr..
<>
TThhee
<>llddaapp__rreessuulltt(())<>
rroouuttiinnee wwiillll bblloocckk oorr nnoott,, ddeeppeennddiinngg uuppoonn tthhee sseettttiinngg
ooff tthhee _t_i_m_e_o_u_t ppaarraammeetteerr..
IIff ttiimmeeoouutt iiss nnoott aa NNUULLLL ppooiinntteerr,,  iitt  ssppeecciiffiieess  aa  mmaaxxiimmuumm
iinntteerrvvaall  ttoo wwaaiitt ffoorr tthhee sseelleeccttiioonn ttoo ccoommpplleettee..  IIff ttiimmeeoouutt
iiss aa NNUULLLL  ppooiinntteerr,, tthhee LLDDAAPP__OOPPTT__TTIIMMEEOOUUTT vvaalluuee sseett bbyy
<>llddaapp__sseett__ooppttiioonn((33))<>
iiss uusseedd.. WWiitthh tthhee ddeeffaauulltt sseettttiinngg,,
tthhee  sseelleecctt  bblloocckkss  iinnddeeffiinniitteellyy..   TToo
eeffffeecctt  aa  ppoollll,,  tthhee  ttiimmeeoouutt aarrgguummeenntt sshhoouulldd bbee aa nnoonn--NNUULLLL
ppooiinntteerr,, ppooiinnttiinngg ttoo aa zzeerroo--vvaalluueedd ttiimmeevvaall ssttrruuccttuurree..  SSeeee
<>sseelleecctt((22))<>
ffoorr ffuurrtthheerr ddeettaaiillss..
<>
IIff tthhee rreessuulltt ooff aa ssppeecciiffiicc ooppeerraattiioonn iiss rreeqquuiirreedd,, _m_s_g_i_d sshhoouulldd
bbee sseett ttoo tthhee iinnvvooccaattiioonn iiddeennttiiffiieerr rreettuurrnneedd wwhheenn tthhee ooppeerraattiioonn wwaass
iinniittiiaatteedd,, ootthheerrwwiissee LLDDAAPP__RREESS__AANNYY oorr LLDDAAPP__RREESS__UUNNSSOOLLIICCIITTEEDD sshhoouulldd bbee
ssuupppplliieedd ttoo wwaaiitt ffoorr aannyy oorr uunnssoolliicciitteedd rreessppoonnssee..
<>
TThhee _a_l_l ppaarraammeetteerr,, iiff nnoonn--zzeerroo,, ccaauusseess
<>llddaapp__rreessuulltt(())<>
ttoo rreettuurrnn aallll rreessppoonnsseess wwiitthh mmssggiidd,, ootthheerrwwiissee oonnllyy tthhee
nneexxtt rreessppoonnssee iiss rreettuurrnneedd..  TThhiiss iiss ccoommmmoonnllyy uusseedd ttoo oobbttaaiinn aallll
tthhee rreessppoonnsseess ooff aa sseeaarrcchh ooppeerraattiioonn..
<>
AA sseeaarrcchh rreessppoonnssee iiss mmaaddee uupp ooff zzeerroo oorr
mmoorree sseeaarrcchh eennttrriieess,, zzeerroo oorr mmoorree sseeaarrcchh rreeffeerreenncceess,, aanndd zzeerroo oorr
mmoorree eexxtteennddeedd ppaarrttiiaall rreessppoonnsseess ffoolllloowweedd bbyy aa sseeaarrcchh rreessuulltt..  IIff
_a_l_l iiss sseett ttoo 00,, sseeaarrcchh eennttrriieess wwiillll bbee rreettuurrnneedd oonnee aatt aa
ttiimmee aass tthheeyy ccoommee iinn,, vviiaa sseeppaarraattee ccaallllss ttoo
<>llddaapp__rreessuulltt(())<>..
IIff iitt''ss sseett ttoo 11,, tthhee sseeaarrcchh
rreessppoonnssee wwiillll oonnllyy bbee rreettuurrnneedd iinn iittss eennttiirreettyy,, ii..ee..,, aafftteerr aallll eennttrriieess,,
aallll rreeffeerreenncceess,, aallll eexxtteennddeedd ppaarrttiiaall rreessppoonnsseess,, aanndd tthhee ffiinnaall sseeaarrcchh
rreessuulltt hhaavvee bbeeeenn rreecceeiivveedd..
<>
UUppoonn ssuucccceessss,, tthhee ttyyppee ooff tthhee rreessuulltt rreecceeiivveedd iiss rreettuurrnneedd aanndd tthhee
_r_e_s_u_l_t ppaarraammeetteerr wwiillll ccoonnttaaiinn tthhee rreessuulltt ooff tthhee ooppeerraattiioonn;;
ootthheerrwwiissee,, tthhee _r_e_s_u_l_t ppaarraammeetteerr iiss uunnddeeffiinneedd..  TThhiiss
rreessuulltt sshhoouulldd bbee ppaasssseedd ttoo tthhee LLDDAAPP ppaarrssiinngg rroouuttiinneess,,
<>llddaapp__ffiirrsstt__mmeessssaaggee((33))<>
aanndd ffrriieennddss,, ffoorr iinntteerrpprreettaattiioonn..
<>
TThhee ppoossssiibbllee rreessuulltt ttyyppeess rreettuurrnneedd aarree::
<>
<>
<>
        LLDDAAPP__RREESS__BBIINNDD ((00xx6611))
        LLDDAAPP__RREESS__SSEEAARRCCHH__EENNTTRRYY ((00xx6644))
        LLDDAAPP__RREESS__SSEEAARRCCHH__RREEFFEERREENNCCEE ((00xx7733))
        LLDDAAPP__RREESS__SSEEAARRCCHH__RREESSUULLTT ((00xx6655))
        LLDDAAPP__RREESS__MMOODDIIFFYY ((00xx6677))
        LLDDAAPP__RREESS__AADDDD ((00xx6699))
        LLDDAAPP__RREESS__DDEELLEETTEE ((00xx66bb))
        LLDDAAPP__RREESS__MMOODDDDNN ((00xx66dd))
        LLDDAAPP__RREESS__CCOOMMPPAARREE ((00xx66ff))
        LLDDAAPP__RREESS__EEXXTTEENNDDEEDD ((00xx7788))
        LLDDAAPP__RREESS__IINNTTEERRMMEEDDIIAATTEE ((00xx7799))
<>
<>
TThhee
<>llddaapp__mmssggffrreeee(())<>
rroouuttiinnee iiss uusseedd ttoo ffrreeee tthhee mmeemmoorryy aallllooccaatteedd ffoorr
rreessuulltt((ss)) bbyy
<>llddaapp__rreessuulltt(())<>
oorr
<>llddaapp__sseeaarrcchh__eexxtt__ss((33))<>
aanndd ffrriieennddss..
IItt ttaakkeess aa ppooiinntteerr ttoo tthhee rreessuulltt oorr rreessuulltt cchhaaiinn ttoo bbee ffrreeeedd aanndd rreettuurrnnss
tthhee ttyyppee ooff tthhee llaasstt mmeessssaaggee iinn tthhee cchhaaiinn..
IIff tthhee ppaarraammeetteerr iiss NNUULLLL,, tthhee ffuunnccttiioonn ddooeess nnootthhiinngg aanndd rreettuurrnnss zzeerroo..
<>
TThhee
<>llddaapp__mmssggttyyppee(())<>
rroouuttiinnee rreettuurrnnss tthhee ttyyppee ooff aa mmeessssaaggee..
<>
TThhee
<>llddaapp__mmssggiidd(())<>
rroouuttiinnee rreettuurrnnss tthhee mmeessssaaggee iidd ooff aa mmeessssaaggee..
<> EERRRROORRSS <>
<>llddaapp__rreessuulltt(())<>
rreettuurrnnss --11 iiff ssoommeetthhiinngg bbaadd hhaappppeennss,, aanndd zzeerroo iiff tthhee
ttiimmeeoouutt ssppeecciiffiieedd wwaass eexxcceeeeddeedd..
<>llddaapp__mmssggttyyppee(())<>
aanndd
<>llddaapp__mmssggiidd(())<>
rreettuurrnn --11 oonn eerrrroorr..
<> SSEEEE AALLSSOO <>
<>llddaapp((33))<>
<>llddaapp__ffiirrsstt__mmeessssaaggee((33))<>
<>sseelleecctt((22))<>
<> AACCKKNNOOWWLLEEDDGGEEMMEENNTTSS <>
<>OOppeennLLDDAAPP SSooffttwwaarree<>
iiss ddeevveellooppeedd aanndd mmaaiinnttaaiinneedd bbyy TThhee OOppeennLLDDAAPP PPrroojjeecctt <>..
<>OOppeennLLDDAAPP SSooffttwwaarree<>
iiss ddeerriivveedd ffrroomm UUnniivveerrssiittyy ooff MMiicchhiiggaann LLDDAAPP 33..33 RReelleeaassee..
<>