swirl
Guide to OmniMark 9   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
    Other Library Functions  
function  

ldapAttributeGetValue

 
 

Library: LDAP support (OMLDAP legacy)
Include: omldap.xin
Return type: String

Returns: A stream.


Declaration

define external stream function ldapAttributeGetValue
             value ldapAttribute attribute
    at       value string        key-value
    item     value integer       item       optional initial { 1 }
    null     value string        null       optional initial { "" }
    datatype value integer       datatype   optional initial { LDAP_TEXT }

Argument definitions

attribute
An ldapAttribute containing the current entry.
key-value
The name of the requested attribute.
item
The position number of the requested item.
null
A string to represent a NULL value for the return value. (This could be set to "NO VALUE", for example.)
datatype
The type of the requested attribute value. The default is LDAP_TEXT; the other option is LDAP_BINARY.


Purpose

This function returns the value of a specified attribute at a specified position for the current entry. The name of this attribute must be placed in the "key-value" parameter and the position must be placed in the "item" parameter.

Example:

     include "omldap.xin"
  
     process
        local ldapAttribute my-entry variable
        local stream myAttributeValue
        ...
       set myAttributeValue to ldapAttributeGetValue my-attribute
            at   key of my-entry
            item 2

      Other Library Functions
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 9.1.0 Documentation Generated: September 2, 2010 at 1:38:10 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2010.