Limit number of attribute values control

Edit online

The Limit number of attribute values control explains its use with the server and provides the results.

Description
This control limits the number of attribute values that are returned for an entry in a search operation. The Limit number of attribute values control is used to limit the number of values that are returned for the entire entry. This control can also be used to limit the number of values that are returned for attribute of an entry.
OID
1.3.18.0.2.10.30
Syntax
  Control ::= SEQUENCE{
        controlType	     1.3.18.0.2.10.30,
        criticality     BOOLEAN DEFAULT FALSE,
        controlValue    OCTET STRING OPTIONAL}
where, the OCTET STRING value is a BER encoded value with the following format: 
  RequestValue ::= SEQUENCE{
     MaxValuesPerEntry   INTEGER(0..maxInt),   // maximum number of values
                                               // for entire entry where 
                                               // 0 means unlimited
     MaxValuesPerAttribute INTEGER(0..maxInt), // maximum number of values 
                                               // per attribute where 
                                               // 0 means unlimited
     ReturnDetails     BOOLEAN DEFAULT FALSE   // FALSE indicates that no 
                                               // response controls should 
                                               // be returned
	}
The response that is sent with each entry whose attributes were partially returned when ReturnDetails is true is: 
  ResultValue ::= SEQUENCE{
     DN            LDAPString,       // The name of the attribute 
                                     // in the same format returned
                                     // by search.
     AttributeList	PartialAttributes // The list of partially returned 
                                     // attributes for an entry.
	}
where, PartialAttributes value is the BER encoded value with the following format: 
  PartialAttributes ::= SEQUENCE of SEQUENCE{
    attributeName         LDAPString,        // The name of the attribute 
                                             // in the same format as 
                                             // returned by search.
    numberValuesReturned  INTEGER(0..maxInt),// number of values returned 
                                             // for an attribute
    numberValuesAvailable INTEGER(-1..maxInt)// number of values available, 
                                             // -1 if unknown
	}
Behavior
The Limit number of attribute values control is registered to be used along with the search operation. At a time, the control can be only used in one search operation. That is, the life of the control lasts only for a single search operation. All the users are authorized to use this control.

When the control is used in a search operation, a total number of attribute values are returned for each entry. The number is less than or equal to the maximum total number of values that are specified on the control. Also, the number of values that are returned per attribute is less than or equal to the maximum number of values that are returned per attribute. If details are requested on the control, a response control is also returned with each entry whose attributes were partially returned. This control is only supported by the RDBM back-end.

The Limit number of attribute values control operates independent of all other controls and does not affect the behavior of any other controls.

The following error codes might be returned if any additional information is required for this control and an error occurs in the formatting of that information:
  • Missing information - LDAP_DECODING_ERROR
  • Additional information - LDAP_DECODING_ERROR
  • Invalid information - LDAP_DECODING_ERROR
This control has the following possible return codes:
  • LDAP_SUCCESS
  • LDAP_DECODING_ERROR
  • LDAP_OPERATIONS_ERROR
  • LDAP_NO_MEMORY
  • LDAP_OTHER
  • LDAP_UNWILLING_TO_PERFORM

This control is not supported by the Administration Server.

Auditing
In this control, no additional information is audited.