DDAP gate, GET_ATTRIBUTE_VALUE function
The GET_ATTRIBUTE_VALUE function of the DDAP gate allows you to retrieve the value associated with an attribute returned by the SEARCH_LDAP call.
Input Parameters
- ATTRIBUTE_TYPE
- Optional parameter
- 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
- 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.
- LDAP_ATTRIBUTE_VALUE
- Indicates the buffer where you want the attribute
value returned. A group of three fullwords are specified for the buffer-descriptor:
- The address where the result is returned.
- The maximum size in bytes, of the data returned.
- The actual length in bytes of the result. This can be specified as *, and the length is then returned in DDAP_LDAP_ATTRIBUTE_VALUE_N.
- SEARCH_TOKEN
- the name of the fullword token that is returned by the SEARCH_LDAP function.
- VALUE_ARRAY_POSITION
- Optional parameter
- Specifies the position of the requested value, in the value array for the current attribute. This parameter is only required if multiple values are expected. Array indexing starts at position 1.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- INVALID_TOKEN
- NOTFOUND
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- LDAP_RESPONSE
- Optional parameter
- specifies the return code that is sent by the LDAP API.