RESPONSE REASON
INVALID None
KERNERROR None
PURGED None
Note: For more detail, refer to the explanation of RESPONSE and REASON in
“Making an XPI call” on page 308.
The GET_ATTRIBUTE_VALUE call
The GET_ATTRIBUTE_VALUEcall allows you to retrieve the value associated with
an attribute returned by the SEARCH_LDAP call. An entry is an LDAPrecord, and
an attribute is one element within an entry.The attribute can be returned by either
the GET_NEXT_ATTRIBUTE function, or by specifying the name of the attribute.

GET_ATTRIBUTE_VALUE

DFHDDAPX [CALL],
[CLEAR],
[IN,
FUNCTION(GET_ATTRIBUTE_VALUE),
SEARCH_TOKEN(name4),
LDAP_ATTRIBUTE_NAME(block-descriptor),
LDAP_ATTRIBUTE_VALUE(buffer-descriptor),
[ATTRIBUTE_TYPE(name4),]
[VALUE_ARRAY_POSITION(name4),]]
[OUT,
[LDAP_RESPONSE(name4),]
RESPONSE(name1 | *),
REASON(name1 | *)]
This command is threadsafe.
ATTRIBUTE_TYPE(name4)
specifies the keyword CHARACTER or BINARY,indicating the format of the
attribute. If this parameter is not specified, a value of CHARACTER is assumed.
LDAP_ATTRIBUTE_NAME(block-descriptor)
specifies the location of the LDAP attribute name. The block-descriptor is two
fullwords of data, in which the first word contains the address of the attribute
name, and the second word contains the length in bytes of the attribute name.
For more information on block-descriptors, see “XPI syntax” on page 319.
LDAP_ATTRIBUTE_VALUE(buffer-descriptor)
indicates the buffer where you want the attribute value returned. Agroup of
three fullwords are specified for the buffer-descriptor:
vThe address where the result is returned.
vThe maximum size in bytes, of the data returned.
vThe actual length in bytes of the result. This can be specified as *, and the
length is then returned in DDAP_LDAP_ATTRIBUTE_VALUE_N.
For more information on buffer-descriptors, see “XPI syntax” on page 319.
LDAP_RESPONSE(name4)
specifies the return code that is sent by the LDAP API.
SEARCH_TOKEN(name4)
the name of the fullword token that is returned by the SEARCH_LDAP function.
Chapter3. The user exit programming interface (XPI) 325