24.49. slapi_str2entry()

Converts an LDIF description of a directory entry (a string value) into an entry of the Slapi_Entry type.
Description

A directory entry can be described by a string in LDIF format; for details, see Section 5.5.2, “Converting Between Entries and Strings”.

Calling the slapi_str2entry() function converts a string description in this format to a Slapi_Entry structure, which you can pass to other API functions.

Note

This function modifies the string argument s. If you still need to use this string value, you should make a copy of this string before calling slapi_str2entry().
If an error occurred during the conversion process, the function returns NULL instead of the entry.
When you are done working with the entry, you should call the slapi_entry_free() function.
To convert an entry to a string description, call the slapi_filter_free() function.
Syntax

#include "slapi-plugin.h"
Slapi_Entry *slapi_str2entry( char *s, int flags );

Parameters

This function takes the following parameters:

s
Description of an entry that you want to convert to Section 14.22, “Slapi_Entry” .
flags
One or more flags specifying how the entry should be generated
The value of the flags argument can be one of the following values:
SLAPI_STR2ENTRY_REMOVEDUPVALS
Removes any duplicate values in the attributes of the entry.
SLAPI_STR2ENTRY_ADDRDNVALS
Adds the relative distinguished name (RDN) components (for example, uid=bjensen) as attributes of the entry.
Returns

This function returns one of the following values:

  • A pointer to the Slapi_Entry structure representing the entry.
  • NULL if the string cannot be converted; for example, if no DN is specified in the string.
See Also

slapi_filter_free()