LDAP methods syntax: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
m (Automatically generated page update)
Line 10: Line 10:
                             <span class="squareb">[</span><span class="literal" title="Stringlist">ReturnAttributes=</span> <span class="term" title="Stringlist">stringlist</span><span class="squareb">]</span><span class="comma">,</span>                  -
                             <span class="squareb">[</span><span class="literal" title="Stringlist">ReturnAttributes=</span> <span class="term" title="Stringlist">stringlist</span><span class="squareb">]</span><span class="comma">,</span>                  -
                             <span class="squareb">[</span><span class="literal" title="String">BaseObject=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p>
                             <span class="squareb">[</span><span class="literal" title="String">BaseObject=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">ldap</span><span class="literal">:[[FindEQ (LDAP function)|FindEQ]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="XmlDoc">doc</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributesOnly=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span>       -
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">ldap</span><span class="literal">:[[FindEQ (LDAP function)|FindEQ]]</span><span class="literal">(</span> <span class="term" title="String">attrib</span><span class="comma">,</span> <span class="term" title="String">searchString</span><span class="comma">,</span> <span class="term" title="XmlDoc">doc</span><span class="comma">,</span>                           -
                        <span class="squareb">[</span><span class="literal" title="Boolean">AttributesOnly=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span>                           -
                         <span class="squareb">[</span><span class="literal" title="Stringlist">ReturnAttributes=</span> <span class="term" title="Stringlist">stringlist</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">BaseObject=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p>
                         <span class="squareb">[</span><span class="literal" title="Stringlist">ReturnAttributes=</span> <span class="term" title="Stringlist">stringlist</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">BaseObject=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">ldap</span><span class="literal">:[[FindGE (LDAP function)|FindGE]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="XmlDoc">doc</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributesOnly=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span>      -
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="term">ldap</span><span class="literal">:[[FindGE (LDAP function)|FindGE]]</span><span class="literal">(</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="String">string</span><span class="comma">,</span> <span class="term" title="XmlDoc">doc</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributesOnly=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span>      -

Revision as of 16:38, 29 August 2011

The syntax for each of the LDAP class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of LDAP methods.

[%number =] ldap:Bind[( [JanusPort= string], [LDAPServer= string], - [PortNumber= number], [UserID= string], - [Password= string], [Options= string])]

%number = ldap:ErrorNumber

%string = ldap:ErrorText

[%number =] ldap:FindApprox( string, string, doc, [AttributesOnly= boolean], - [ReturnAttributes= stringlist], - [BaseObject= string])

[%number =] ldap:FindEQ( attrib, searchString, doc, - [AttributesOnly= boolean], - [ReturnAttributes= stringlist], [BaseObject= string])

[%number =] ldap:FindGE( string, string, doc, [AttributesOnly= boolean], - [ReturnAttributes= stringlist], [BaseObject= string])

[%number =] ldap:FindLE( string, string, doc, [AttributesOnly= boolean], - [ReturnAttributes= stringlist], [BaseObject= string])

[%number =] ldap:FindStringInCommonName( string, doc, - [AttributesOnly= boolean], - [ReturnAttributes= stringlist], - [BaseObject= string])

%ldap = [%(LDAP)]:New

[%number =] ldap:Unbind