Sun Java System Directory Server Enterprise Edition 6.1 Developer's Guide

Functions by Functional Area

This section categorizes plug-in functions by functional area.

Table 16–1 Functions for Handling Parameter Blocks

Function 

Description 

slapi_pblock_destroy()

Frees a parameter block from memory. 

slapi_pblock_get()

Gets the value from a parameter block. 

slapi_pblock_new()

Creates a new parameter block. 

slapi_pblock_set()

Sets the value of a parameter block. 

Table 16–2 Functions for Handling Memory

Function 

Description 

slapi_ch_array_free()

Frees an existing array. 

slapi_ch_bvdup()

Makes a copy of an existing berval structure.

slapi_ch_bvecdup()

Makes a copy of an array of existing berval structures.

slapi_ch_calloc()

Allocates space for an array of a number of elements of a specified size. 

slapi_ch_free()

Frees space allocated by the slapi_ch_malloc(), slapi_ch_realloc(), and slapi_ch_calloc() functions.

slapi_ch_free_string()

Frees an existing string. 

slapi_ch_malloc()

Allocates space in memory. 

slapi_ch_realloc()

Changes the size of a block of allocated memory. 

slapi_ch_strdup()

Makes a copy of an existing string. 

Table 16–3 Functions for Handling Access Control

Function 

Description 

slapi_access_allowed()

Determines if the user requesting the current operation has the access rights to perform an operation on a given entry, attribute, or value. 

slapi_acl_check_mods()

Determines if a user has the rights to perform the specified modifications on an entry. 

slapi_acl_verify_aci_syntax()

Determines whether or not the access control items (ACIs) on an entry are valid. 

Table 16–4 Functions for Handling Attributes

Function 

Description 

slapi_attr_add_value()

Adds a value to an attribute. 

slapi_attr_basetype()

Returns the base type of an attribute. 

slapi_attr_dup()

Duplicates an attribute. 

slapi_attr_first_value_const()

Gets the first value of an attribute. 

slapi_attr_flag_is_set()

Determines if certain flags are set. 

slapi_attr_free()

Frees an attribute. 

slapi_attr_get_bervals_copy()

Puts the values contained in an attribute into an array of berval structures.

slapi_attr_get_flags()

Gets the flags associated with an attribute. 

slapi_attr_get_numvalues()

Puts the count of values of an attribute into an integer. 

slapi_attr_get_oid_copy()

Searches for an attribute type and gives its OID string. 

slapi_attr_get_type()

Gets the name of the attribute type. 

slapi_attr_get_valueset()

Copies attribute values into a value set. 

slapi_attr_init()

Initializes an empty attribute. 

slapi_attr_new()

Creates a new attribute. 

slapi_attr_next_value_const()

Gets the next value of an attribute. 

slapi_attr_syntax_normalize()

Returns a copy of the normalized attribute types. 

slapi_attr_type_cmp()

Compares two attributes. 

slapi_attr_types_equivalent()

Compares two attribute names to determine if they represent the same attribute. 

slapi_attr_value_cmp()

Compares two attribute values. 

slapi_attr_value_find()

Determines if an attribute contains a given value. 

Table 16–5 Functions for Handling Basic Encoding Rule Values

Function 

Description 

slapi_berval_cmp()

Compares two berval structures.

slapi_ch_bvdup()

Makes a copy of an existing berval structure.

slapi_ch_bvecdup()

Makes a copy of an array of existing berval structures.

Table 16–6 Functions for Handling Controls

Function 

Description 

slapi_build_control()

Creates an LDAPControl structure based on a BerElement, an OID, and a criticality flag.

slapi_entry_get_uniqueid()

Retrieves an allocated array of object identifiers (OIDs) representing the controls supported by Directory Server. 

slapi_control_present()

Determines whether or not the specified object identification (OID) identifies a control that is present in a list of controls. 

slapi_dup_control()

Makes an allocated copy of an LDAPControl.

slapi_register_supported_control()

Registers the specified control with the server. This function associates the control with an object identification (OID). 

Table 16–7 Functions for Handling Distinguished Name Strings

Function 

Description 

slapi_dn_beparent()

Gets a copy of the DN of the parent of an entry. 

slapi_dn_ignore_case()

Converts all characters in a DN to lowercase. 

slapi_dn_isbesuffix()

Determines if a DN is the suffix of the local database. 

slapi_dn_isbesuffix_norm()

Determines if a DN is the suffix of the local database. 

slapi_dn_isparent()

Determines if a DN is the parent of a specific DN. 

slapi_dn_isroot()

Determines if a DN is the root DN for the local database. 

slapi_dn_issuffix()

Determines if a DN is equal to a specified suffix. 

slapi_dn_normalize()

Converts a DN to canonical format. 

slapi_dn_normalize_case()

Converts a DN to canonical format and all characters to lower case. 

slapi_dn_normalize_to_end()

Normalizes part of a DN value. 

slapi_dn_parent()

Gets the DN of the parent of an entry. 

slapi_dn_plus_rdn()

Adds an RDN to a DN. 

Table 16–8 Functions for Handling Entries

Function 

Description 

slapi_entry2str()

Generates an LDIF string description. 

slapi_entry2str_with_options()

Generates an LDIF string descriptions with options. 

slapi_entry_add_rdn_values()

Add components in an entry’s RDN. 

slapi_entry_add_string()

Adds a string value to an attribute in an entry. 

slapi_entry_add_values_sv()

Adds a data value to an attribute in an entry. 

slapi_entry_add_valueset()

Adds a data value to an attribute in an entry. 

slapi_entry_alloc()

Allocates memory for a new entry. 

slapi_entry_attr_delete()

Deletes an attribute from an entry. 

slapi_entry_attr_find()

Checks if an entry contains a specific attribute. 

slapi_entry_attr_get_charptr()

Gets the first value as a string. 

slapi_entry_attr_get_int()

Gets the first value as an integer. 

slapi_entry_attr_get_long()

Gets the first value as a long. 

slapi_entry_attr_get_uint()

Gets the first value as an unsigned integer. 

slapi_entry_attr_get_ulong()

Gets the first value as an unsigned long. 

slapi_entry_attr_hasvalue()

Checks if an attribute in an entry contains a value. 

slapi_entry_attr_merge_sv()

Adds an array to the attribute values in an entry. 

slapi_entry_attr_replace_sv()

Replaces the attribute values in an entry. 

slapi_entry_attr_set_charptr()

Replaces the values of an attribute with a string. 

slapi_entry_attr_set_int()

Replaces the value of an attribute with an integer. 

slapi_entry_attr_set_long()

Replaces the value of an attribute with a long. 

slapi_entry_attr_set_uint()

Replaces the value of an attribute with an unsigned integer. 

slapi_entry_attr_set_ulong()

Replaces the value of an attribute with an unsigned long. 

slapi_entry_delete_string()

Deletes a string from an attribute. 

slapi_entry_delete_values_sv()

Removes a Slapi_Value array from an attribute.

slapi_entry_dup()

Copies an entry, its DN, and its attributes. 

slapi_entry_first_attr()

Finds the first attribute in an entry. 

slapi_entry_free()

Frees an entry from memory. 

slapi_entry_get_dn()

Gets the DN from an entry. 

slapi_entry_get_dn_const()

Returns the DN of an entry as a constant. 

slapi_entry_get_ndn()

Returns the NDN of an entry. 

slapi_entry_get_sdn()

Returns the Slapi_DN from an entry.

slapi_entry_get_sdn_const()

Returns a Slapi_DN from an entry as a constant.

slapi_entry_get_uniqueid()

Gets the unique ID from an entry. 

slapi_entry_has_children()

Determines if the specified entry has child entries. 

slapi_entry_init()

Initializes the values of an entry. 

slapi_entry_isroot()

Determines whether the entry is that of a directory super user. 

slapi_entry_merge_values_sv()

Adds an array of data values to an attribute in an entry. 

slapi_entry_next_attr()

Finds the next attribute in an entry. 

slapi_entry_rdn_values_present()

Checks if values present in an entry’s RDN are also present as attribute values. 

slapi_entry_schema_check()

Determines if an entry complies with the schema for its object class. 

slapi_entry_schema_check_ext()

Determines if a set of modifications to an entry comply with the schema. 

slapi_entry_set_dn()

Sets the DN of an entry. 

slapi_entry_set_sdn()

Sets the Slapi_DN value in an entry.

slapi_entry_size()

Returns the size of an entry. 

slapi_entry_syntax_check()

Determines if the attributes of an entry comply with attribute syntax rules. 

slapi_entry_vattr_find()

Finds the specified virtual attribute in the entry. 

slapi_is_rootdse()

Determines if an entry is the root DSE. 

slapi_str2entry()

Converts an LDIF description into an entry. 

Table 16–9 Functions for Handling Extended Operations

Function 

Description 

slapi_get_supported_extended_ops_copy()

Gets a copy of the object IDs (OIDs) of the extended operations. 

Table 16–10 Functions for Handling Filters

Function 

Description 

slapi_filter_compare()

Determines if two filters are identical. 

slapi_filter_free()

Frees the specified filter. 

slapi_filter_get_attribute_type()

Gets the attribute type for all simple filter choices. 

slapi_filter_get_ava()

Gets the attribute type and the value from the filter. 

slapi_filter_get_choice()

Gets the type of the specified filter. 

slapi_filter_get_subfilt()

Gets the substring values from the filter. 

slapi_filter_get_type()

Gets the attribute type specified in the filter. 

slapi_filter_join()

Joins two specified filters. 

slapi_filter_list_first()

Gets the first filter that makes up the specified filter. 

slapi_filter_list_next()

Gets the next filter. 

slapi_filter_test()

Determines if the specified entry matches a particular filter. 

slapi_filter_test_ext()

Determines if an entry matches a given filter. 

slapi_filter_test_simple()

Determines if an entry matches a filter. 

slapi_str2filter()

Converts a string description of a search filter into a filter of the Slapi_Filter type.

Table 16–11 Functions for Handling Internal Operations

Function 

Description 

slapi_add_entry_internal_set_pb()

Prepare a Slapi_PBlock structure for an internal add operation involving a Slapi_Entry structure.

slapi_add_internal_pb()

Adds an LDAP add operation based on a parameter block to add a new directory entry. 

slapi_add_internal_set_pb()

Prepare a Slapi_PBlock structure for an internal add operation.

slapi_delete_internal_pb()

Performs an LDAP delete operation based on a parameter block to remove a directory entry 

slapi_delete_internal_set_pb()

Prepare a Slapi_PBlock structure for an internal delete operation.

slapi_free_search_results_internal()

Frees search results. 

slapi_modify_internal_pb()

Performs an LDAP modify operation based on a parameter block to modify a directory entry. 

slapi_modify_internal_set_pb()

Prepare a Slapi_PBlock structure for an internal modify operation.

slapi_modrdn_internal_pb()

Performs an LDAP modify RDN operation based on a parameter block to rename a directory entry. 

slapi_rename_internal_set_pb()

Prepare a Slapi_PBlock structure for an internal modify RDN operation.

slapi_search_internal_callback_pb()

Performs an LDAP search operation based on a parameter block to search the directory. 

slapi_search_internal_get_entry()

Performs an internal search operation to read one entry 

slapi_search_internal_pb()

Performs an LDAP search operation based on a parameter block to search the directory. 

slapi_search_internal_set_pb()

Prepare a Slapi_PBlock structure for an internal search operation.

Table 16–12 Functions for Handling Matching Rules

Function 

Description 

slapi_matchingrule_free()

Free a Slapi_MatchingRuleEntry after registering the matching rule.

slapi_matchingrule_get()

Access a Slapi_MatchingRuleEntry.

slapi_matchingrule_new()

Allocate a Slapi_MatchingRuleEntry structure.

slapi_matchingrule_register()

Register a matching rule with the server. 

slapi_matchingrule_set()

Modify a Slapi_MatchingRuleEntry.

slapi_mr_filter_index()

Call a matching rule filter index function. 

slapi_mr_indexer_create()

Get a pointer to the indexer factory function for a matching rule. 

Table 16–13 Functions for Handling Modifications

Function 

Description 

slapi_entry2mods()

Creates an array of LDAPMod from a Slapi_Entry.

slapi_ldapmods_syntax_check()

Determines if the proposed modifications to an entry comply with attribute syntax rules. 

slapi_mod_add_value()

Adds a value to a Slapi_Mod structure.

slapi_mod_done()

Frees internals of Slapi_Mod structure.

slapi_mod_dump()

Dumps the contents of an LDAPMod to the server log.

slapi_mod_free()

Frees a Slapi_Mod structure.

slapi_mod_get_first_value()

Initializes a Slapi_Mod iterator and returns the first attribute value.

slapi_mod_get_ldapmod_byref()

Gets a reference to the LDAPMod in a Slapi_Mod structure.

slapi_mod_get_ldapmod_passout()

Retrieves the LDAPMod contained in a Slapi_Mod structure.

slapi_mod_get_next_value()

Increments the Slapi_Mod iterator and returns the next attribute value.

slapi_mod_get_num_values()

Gets the number of values in a Slapi_Mod structure.

slapi_mod_get_operation()

Gets the operation type of Slapi_Mod structure.

slapi_mod_get_type()

Gets the attribute type of a Slapi_Mod structure.

slapi_mod_init()

Initializes a Slapi_Mod structure.

slapi_mod_init_byref()

Initializes a Slapi_Mod structure that is a wrapper for an existing LDAPMod.

slapi_mod_init_byval()

Initializes a Slapi_Mod structure with a copy of an LDAPMod.

slapi_mod_init_passin()

Initializes a Slapi_Mod from an LDAPMod.

slapi_mod_isvalid()

Determines whether a Slapi_Mod structure is valid.

slapi_mod_new()

Allocates a new Slapi_Mod structure.

slapi_mod_remove_value()

Removes the value at the current Slapi_Mod iterator position.

slapi_mod_set_operation()

Sets the operation type of a Slapi_Mod structure.

slapi_mod_set_type()

Sets the attribute type of a Slapi_Mod.

slapi_mods2entry()

Creates a Slapi_Entry from an array of LDAPMod.

slapi_mods_add()

Appends a new mod with a single attribute value to Slapi_Mods structure.

slapi_mods_add_ldapmod()

Appends an LDAPMod to a Slapi_Mods structure.

slapi_mods_add_mod_values()

Appends a new mod to a Slapi_Mods structure, with attribute values provided as an array of Slapi_Value.

slapi_mods_add_modbvps()

Appends a new mod to a Slapi_Mods structure, with attribute values provided as an array of berval.

slapi_mods_add_smod()

Appends a Slapi_Mod to a Slapi_Mods structure.

slapi_mods_add_string()

Appends a new mod to Slapi_Mods structure with a single attribute value provided as a string.

slapi_mods_done()

Frees internals of a Slapi_Mods structure.

slapi_mods_dump()

Dumps the contents of a Slapi_Mods structure to the server log.

slapi_mods_free()

Frees a Slapi_Mods structure.

slapi_mods_get_first_mod()

Initializes a Slapi_Mods iterator and returns the first LDAPMod.

slapi_mods_get_first_smod()

Initializes a Slapi_Mods iterator and returns the first mod wrapped in a Slapi_Mods structure.

slapi_mods_get_ldapmods_byref()

Gets a reference to the array of LDAPMod in a Slapi_Mods structure.

slapi_mods_get_ldapmods_passout()

Retrieves the array of LDAPMod contained in a Slapi_Mods structure.

slapi_mods_get_next_mod()

Increments the Slapi_Mods iterator and returns the next LDAPMod.

slapi_mods_get_next_smod()

Increments the Slapi_Mods iterator and returns the next mod wrapped in a Slapi_Mods.

slapi_mods_get_num_mods()

Gets the number of mods in a Slapi_Mods structure.

slapi_mods_init()

Initializes a Slapi_Mods.

slapi_mods_init_byref()

Initializes a Slapi_Mods that is a wrapper for an existing array of LDAPMod.

slapi_mods_init_passin()

Initializes a Slapi_Mods structure from an array of LDAPMod.

slapi_mods_insert_after()

Inserts an LDAPMod into a Slapi_Mods structure after the current iterator position.

slapi_mods_insert_at()

Inserts an LDAPMod anywhere in a Slapi_Mods.

slapi_mods_insert_before()

Inserts an LDAPMod into a Slapi_Mods structure before the current iterator position.

slapi_mods_insert_smod_at()

Inserts a Slapi_Mod anywhere in a Slapi_Mods.

slapi_mods_insert_smod_before()

Inserts a Slapi_Mod into a Slapi_Mods structure before the current iterator position.

slapi_mods_iterator_backone()

Decrements the Slapi_Mods current iterator position.

slapi_mods_new()

Allocates a new uninitialized Slapi_Mods structure.

slapi_mods_remove()

Removes the mod at the current Slapi_Mods iterator position.

slapi_mods_remove_at()

Removes the mod at the specified Slapi_Mods iterator position.

Table 16–14 Functions for Handling Operations

Function 

Description 

slapi_op_abandoned()

Determines if the client has abandoned the current operation. 

slapi_op_get_type()

Gets the type of a Slapi_Operation.

Table 16–15 Functions for Handling Passwords

Function 

Description 

slapi_pw_find_sv()

Determines whether or not a specified password matches one of the hashed values of an attribute. 

slapi_pw_find_valueset()

Determines whether or not a specified password matches one of the hashed values of an attribute. 

Table 16–16 Functions for Handling Roles

Function 

Description 

slapi_register_role_get_scope()

Register a callback to determine the scope of a role. 

slapi_role_check()

Checks if the entry pointed to contains the role indicated. 

slapi_role_get_scope()

Determine the scope of a role. 

Table 16–17 Functions for Handling SASL Mechanisms

Function 

Description 

slapi_get_supported_saslmechanisms_copy()

Gets an array of the names of the supported Simple Authentication and Security Layer (SASL) mechanisms. 

slapi_register_supported_saslmechanism()

Registers the specified Simple Authentication and Security Layer (SASL) mechanism with the server. 

Table 16–18 Functions for Handling Slapi_Backend Structures

Function 

Description 

slapi_be_exist()

Checks if the backend that contains the specified DN exists. 

slapi_be_get_name()

Returns the name of the specified backend. 

slapi_be_get_readonly()

Indicates if the database associated with the backend is in read-only mode. 

slapi_be_getsuffix()

Returns the n+1 suffix associated with the specified backend.

slapi_be_gettype()

Returns the type of the backend. 

slapi_be_is_flag_set()

Checks if a flag is set in the backend configuration. 

slapi_be_issuffix()

Verifies that the specified suffix matches a registered backend suffix. 

slapi_be_logchanges()

Indicates if the changes applied to the backend should be logged in the change log. 

slapi_be_private()

Verifies if the backend is private. 

slapi_be_select()

Finds the backend that should be used to service the entry with the specified DN. 

slapi_be_select_by_instance_name()

Find the backend used to service the database. 

slapi_get_first_backend()

Returns a pointer of the backend structure of the first backend. 

slapi_get_next_backend()

Returns a pointer to the next backend. 

slapi_is_root_suffix()

Checks if a suffix is a root suffix of the DIT. 

Table 16–19 Functions for Handling Slapi_DN Structures

Function 

Description 

slapi_moddn_get_newdn()

Builds the new DN of an entry. 

slapi_sdn_compare()

Compares two DNs. 

slapi_sdn_copy()

Copies a DN. 

slapi_sdn_done()

Clears a Slapi_DN structure.

slapi_sdn_dup()

Duplicates a Slapi_DN structure.

slapi_sdn_free()

Frees a Slapi_DN structure.

slapi_sdn_get_backend_parent()

Gets the DN of the parent within a specific backend. 

slapi_sdn_get_dn()

Gets the DN from a Slapi_DN structure.

slapi_sdn_get_ndn()

Gets the normalized DN of a Slapi_DN structure.

slapi_sdn_get_ndn_len()

Gets the length of the normalized DN of a Slapi_DN structure.

slapi_sdn_get_parent()

Get the parent DN of a given Slapi_DN structure.

slapi_sdn_get_rdn()

Gets the RDN from a DN. 

slapi_sdn_get_suffix()

Gets the suffix holding the entry specified by DN. 

slapi_sdn_isempty()

Checks if there is a DN value stored in a Slapi_DN structure.

slapi_sdn_isgrandparent()

Checks if a DN is the parent of the parent of a DN. 

slapi_sdn_isparent()

Checks if a DN is the parent of a DN. 

slapi_sdn_issuffix()

Checks if a Slapi_DN structure contains a suffix of another.

slapi_sdn_new()

Allocates new Slapi_DN structure.

slapi_sdn_new_dn_byref()

Creates a new Slapi_DN structure pointing to an existing DN string.

slapi_sdn_new_dn_byval()

Creates a new Slapi_DN structure copying an existing DN string.

slapi_sdn_new_dn_passin()

Creates a new Slapi_DN structure pointing to a new copy of a DN string.

slapi_sdn_new_ndn_byref()

Creates a new Slapi_DN structure pointing to an existing normalized DN.

slapi_sdn_new_ndn_byval()

Creates a new Slapi_DN structure copying an existing normalized DN.

slapi_sdn_scope_test()

Checks if an entry is in the scope of a certain base DN. 

slapi_log_info_ex()

Sets a DN value in a Slapi_DN structure pointing to an existing DN string.

slapi_sdn_set_dn_byval()

Sets a DN value in a Slapi_DN structure copying an existing DN string.

slapi_sdn_set_dn_passin()

Sets a DN value in a Slapi_DN structure pointing to a new copy of a DN string.

slapi_sdn_set_ndn_byref()

Sets a normalized DN in a Slapi_DN structure pointing to an existing normalized DN string.

slapi_sdn_set_ndn_byval()

Sets a normalized DN in a Slapi_DN structure copying an existing normalized DN string.

slapi_sdn_set_parent()

Sets a new parent in an entry. 

slapi_sdn_set_rdn()

Sets a new RDN for an entry. 

Table 16–20 Functions for Handling Slapi_RDN Structures

Function 

Description 

slapi_rdn_add()

Adds a new RDN to an existing RDN structure. 

slapi_rdn_compare()

Compares two RDNs. 

slapi_rdn_contains()

Checks if a Slapi_RDN structure holds any RDN matching a given type/value pair.

slapi_rdn_contains_attr()

Checks if a Slapi_RDN structure contains any RDN matching a given type.

slapi_rdn_done()

Clears a Slapi_RDN structure.

slapi_rdn_free()

Frees a Slapi_RDN structure.

slapi_rdn_get_first()

Gets the type/value pair of the first RDN. 

slapi_rdn_get_index()

Gets the index of the RDN. 

slapi_rdn_get_index_attr()

Gets the position and the attribute value of the first RDN. 

slapi_rdn_get_next()

Gets the RDN type/value pair from the RDN. 

slapi_rdn_get_num_components()

Gets the number of RDN type/value pairs. 

slapi_rdn_get_rdn()

Gets the RDN from a Slapi_RDN structure.

slapi_rdn_init()

Initializes a Slapi_RDN structure with NULL values.

slapi_rdn_init_dn()

Initializes a Slapi_RDN structure from an existing DN string.

slapi_rdn_init_rdn()

Initializes a Slapi_RDN structure from an existing Slapi_RDN structure.

slapi_rdn_init_sdn()

Initializes a Slapi_RDN structure from an existing Slapi_DN structure.

slapi_rdn_isempty()

Checks if an RDN value is stored in a Slapi_RDN structure.

slapi_rdn_new()

Creates a new Slapi_RDN structure.

slapi_rdn_new_dn()

Creates a new Slapi_RDN structure.

slapi_rdn_new_rdn()

Creates a new Slapi_RDN structure.

slapi_rdn_new_sdn()

Creates a new Slapi_RDN structure.

slapi_rdn_syntax_check()

Determines if and RDN complies with attribute syntax rules. 

Table 16–21 Functions for Handling Slapi_Value Structures

Function 

Description 

slapi_value_compare()

Compares two values. 

slapi_value_done()

Frees internals of a value. 

slapi_value_dup()

Duplicates a value. 

slapi_value_free()

Frees a Slapi_Value structure from memory.

slapi_value_get_berval()

Gets the berval structure of the value.

slapi_value_get_int()

Converts the value of an integer. 

slapi_value_get_length()

Gets the length of a value. 

slapi_value_get_long()

Converts a value into a long integer. 

slapi_value_get_string()

Returns the value as a string. 

slapi_value_get_uint()

Converts the value into an unsigned integer. 

slapi_value_get_ulong()

Converts the value into an unsigned long. 

slapi_value_init()

Initializes a Slapi_Value structure with no values.

slapi_value_init_berval()

Initializes a Slapi_Value structure from the berval structure.

slapi_value_init_string()

Initializes a Slapi_Value structure from a string.

slapi_value_init_string_passin()

Initializes a Slapi_Value structure with a value contained in a string.

slapi_value_new()

Allocates a new Slapi_Value structure.

slapi_value_new_berval()

Allocates a new Slapi_Value structure from a berval structure.

slapi_value_new_string()

Allocates a new Slapi_Value structure from a string.

slapi_value_new_string_passin()

Allocates a new Slapi_Value structure and initializes it from a string.

slapi_value_new_value()

Allocates a new Slapi_Value from another Slapi_Value structure.

slapi_value_set()

Sets the value. 

slapi_value_set_berval()

Copies the value from a berval structure into a Slapi_Value structure.

slapi_value_set_int()

Sets the integer value of a Slapi_Value structure.

slapi_value_set_string()

Copies a string into the value. 

slapi_value_set_string_passin()

Sets the value. 

slapi_value_set_value()

Copies the value of a Slapi_Value structure into another Slapi_Value structure.

Table 16–22 Functions for Handling Slapi_ValueSet Structures

Function 

Description 

slapi_valueset_add_value_optimised()

Adds a Slapi_Value in the Slapi_ValueSet structure.

slapi_valueset_count()

Returns the number of values contained in a Slapi_ValueSet structure.

slapi_valueset_done()

Frees the values contained in the Slapi_ValueSet structure.

slapi_valueset_find_const()

Finds the value in a value set by using the syntax of an attribute. 

slapi_valueset_first_value_const()

Gets the first value of a Slapi_ValueSet structure.

slapi_valueset_free()

Frees the specified Slapi_ValueSet structure and its members from memory.

slapi_valueset_init()

Resets a Slapi_ValueSet structure to no values.

slapi_valueset_new()

Allocates a new Slapi_ValueSet structure.

slapi_valueset_next_value_const()

Gets the next value from a Slapi_ValueSet structure.

slapi_valueset_set_from_smod()

Copies the values of Slapi_Mod structure into a Slapi_ValueSet structure.

slapi_valueset_set_valueset_optimised()

Initializes a Slapi_ValueSet structure from another Slapi_ValueSet structure.

Table 16–23 Functions for Handling UTF-8 Strings

Function 

Description 

slapi_has8thBit()

Checks if a string has an 8-bit character. 

slapi_UTF-8CASECMP()

Compares two UTF-8 strings. 

slapi_UTF-8NCASECMP()

Compares a specified number of UTF-8 characters. 

slapi_UTF-8ISLOWER()

Verifies if a UTF-8 character is lower case. 

slapi_UTF-8ISUPPER()

Verifies if a single UTF-8 character is upper case. 

slapi_UTF-8STRTOLOWER()

Converts a UTF-8 string to lower case. 

slapi_UTF-8STRTOUPPER()

Converts a string made up of UTF-8 characters and converts it to upper case. 

slapi_UTF-8TOLOWER()

Converts a UTF-8 character to lower case. 

slapi_UTF-8TOUPPER()

Converts a lower case UTF-8 character to an upper case character. 

Table 16–24 Functions for Writing Log Messages

Function 

Description 

slapi_log_error_ex()

Writes an error message to the server error log 

slapi_log_info_ex()

Writes an informational message to the server error log 

slapi_log_warning_ex()

Writes a warning message to the server error log 

Table 16–25 Functions for Handling Virtual Attributes

Function 

Description 

slapi_vattr_is_virtual()

Determines if the value of the specified attribute type is virtually generated. 

slapi_vattr_value_compare()

Compares attribute type and name in a given entry. 

slapi_vattr_values_free()

Frees the value set and type names. 

slapi_vattr_values_get_ex()

Returns the values for an attribute type from an entry. 

Table 16–26 Functions for Sending Entries, Referrals, and Results to Clients

Function 

Description 

slapi_send_ldap_referral()

Processes an entry’s LDAP v3 referrals. 

slapi_send_ldap_result()

Sends a result code back to the client. 

slapi_send_ldap_search_entry()

Sends an entry found by a search back to the client. 

Table 16–27 Function for Registering Plug-Ins

Function 

Description 

slapi_register_plugin()

Register another plug-in.