swirl Guide to OmniMark 6   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesOMX VariablesErrors
 
      Other Library Functions  
function   ldapAttributeGetValue   Available in:
Enterprise

Library: omldap - LDAP support
Include: omldap.xin
Return type: String
Returns:       

A stream.


Declaration

  define external stream function ldapAttributeGetValue
               value ldapAttribute attribute
      at       value stream        key-value
      item     value integer       item       optional initial { 1 }
      null     value stream        null       optional initial { "" }
      datatype value integer       datatype   optional initial { LDAP_TEXT }
  where
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
   ldap_IsVersionCompatible
   ldap_LibraryVersion
   ldapAddEntry
   ldapAttribute
   ldapAttributeGetValue
   ldapAttributeGetValues
   ldapClose
   ldapConnection
   ldapCreateAttribute
   ldapDeleteEntry
   ldapEntryAdvance
   ldapEntryExists
   ldapEntryGetName
   ldapModifyEntry
   ldapOpen
   ldapRenameEntry
   ldapSearch
 
----  

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

OmniMark 6.5 Documentation Generated: December 23, 2002 at 6:25:26 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © OmniMark Technologies Corporation, 1988-2002.