33.34. slapi_mods_get_first_smod()

Description

This function initializes a Slapi_Mods iterator and returns the first mod wrapped in a Slapi_Mods structure. Use this function in conjunction with slapi_mods_get_next_smod() to iterate through the mods in a Slapi_Mods using a Slapi_Mods wrapper.

Syntax

#include "slapi-plugin.h"
Slapi_Mod *slapi_mods_get_first_smod(Slapi_Mods *smods, Slapi_Mod *smod);

Parameters

This function takes the following parameters:

mods
A pointer to a an initialized Slapi_Mods.
smod
Pointer to a Slapi_Mods that will be used to hold the mod.
Returns

This function returns one of the following values:

  • A pointer to the Slapi_Mod, wrapping the first mod.
  • NULL if no mod exist.
Memory Concerns

Only one thread may be iterating through a particular Slapi_Mods at any given time.