43.6. slapi_valueset_first_value()

Description

Call this function when you wish to get the first value of a Slapi_ValueSet or you wish to iterate through all of the values. The returned value is the index of the value in the Slapi_ValueSet structure and must be passed to call slapi_valueset_next_value() to get the next value.

Syntax

#include "slapi-plugin.h"
int slapi_valueset_first_value( Slapi_ValueSet *vs, Slapi_Value **v );

Parameters

This function takes the following parameters:

vs
Pointer to the Slapi_ValueSet structure from which you wish to get the value.
v
Address of the pointer to the Slapi_Value structure for the returned value.
Returns

This function returns one of the following values:

  • The index of the value in the Slapi_ValueSet.
  • -1 if there was no value.
Memory Concerns

This function gives a pointer to the actual value within the Slapi_ValueSet. You should not free it from memory.