LDAPVLVInfo

Contains state information associated with a series of virtual list view interactions between a client and an LDAP server.

Structure

  typedef struct ldapvlvinfo {
     int             ldvlv_version;
     unsigned long   ldvlv_before_count;
     unsigned long   ldvlv_after_count
     unsigned long   ldvlv_offset;
     unsigned long   ldvlv_count;
     struct berval   *ldvlv_attrvalue;
     struct berval   *ldvlv_context;
     void            *ldvlv_extradata;
  } LDAPVLVInfo;
  

Fields

ldvlv_version

Specifies the version of this structure, which is currently 1.

ldvlv_before_count

Specifies the number of entries before the target entry that the client wants the server to return.

ldvlv_after_count

Specifies the number of entries after the target entry that the client wants the server to return.

ldvlv_offset

Specifies the target entry's position in the list. This parameter is used in connection with the ldvlv_count field, but is used only if the ldvlv_attrvalue field is NULL.

ldvlv_count

Specifies the total number of entries in the list. This parameter is used in connection with the ldvlv_offset field, but is used only if the ldvlv_attrvalue field is NULL. The following values have special consequences:

  • If the ldvlv_count field is set to 0, the Novell LDAP server returns the entry specified by the ldvlv_offset parameter and sets this field to the number of entries currently in the list.

  • If the value of the ldvlv_count field does not match the current number of entries in the list, the Novell LDAP server assumes that the ldvlv_offset parameter is relative to ldvlv_count. For example, if the list contains 10,000 entries and you specify the count as 500 and the offset as 250, the middle entry of the list is returned which, in this case, is entry number 5,000.

ldvlv_attrvalue

Points to the attribute value that the target entry's attribute is equal to or greater than. This can be used as a typedown value. For example, if the value specified is abc, the target entry will be the first entry in the list with abc, or if no abc entries exist, the first entry with abd. If this field is NULL, the ldvlv_offset and ldvlv_count fields are used to select the target entry.

ldvlv_context

Points to server-specific data. On the first call, set this field to NULL. The server returns data that helps the server track who you are and where you are in the list. The context obtained from calling the ldap_parse_vlv_control function should be used as the context in the next ldap_create_vlv_control call.

ldvlv_extradata

Reserved for application specific data. The virtual list view control does not use this field.