Directory Service Functions
[Core Library]

Functions
switch_status_t	switch_core_directory_open (switch_directory_handle_t *dh, char *module_name, char *source, char *dsn, char *passwd, switch_memory_pool_t *pool)
	Open a directory handle.
switch_status_t	switch_core_directory_query (switch_directory_handle_t *dh, char *base, char *query)
	Query a directory handle.
switch_status_t	switch_core_directory_next (switch_directory_handle_t *dh)
	Obtain the next record in a lookup.
switch_status_t	switch_core_directory_next_pair (switch_directory_handle_t *dh, char **var, char **val)
	Obtain the next name/value pair in the current record.
switch_status_t	switch_core_directory_close (switch_directory_handle_t *dh)
	Close an open directory handle.

---

Function Documentation

switch_status_t switch_core_directory_close (  switch_directory_handle_t *  dh  )

Close an open directory handle. Parameters: dh  a direcotry handle to close Returns: SWITCH_STATUS_SUCCESS if handle was closed { switch_status_t status; status = dh->directory_interface->directory_close(dh); if (switch_test_flag(dh, SWITCH_DIRECTORY_FLAG_FREE_POOL)) { switch_core_destroy_memory_pool(&dh->memory_pool); } return status; }

switch_status_t switch_core_directory_next (  switch_directory_handle_t *  dh  )

Obtain the next record in a lookup. Parameters: dh  a direcotry handle to use Returns: SWITCH_STATUS_SUCCESS if another record exists { return dh->directory_interface->directory_next(dh); }

switch_status_t switch_core_directory_next_pair (  switch_directory_handle_t *  dh, char **  var, char **  val )

Obtain the next name/value pair in the current record. Parameters: dh  a direcotry handle to use var  a pointer to pointer of the name to fill in val  a pointer to poinbter of the value to fill in Returns: SWITCH_STATUS_SUCCESS if an item exists { return dh->directory_interface->directory_next_pair(dh, var, val); }

switch_status_t switch_core_directory_open (  switch_directory_handle_t *  dh, char *  module_name, char *  source, char *  dsn, char *  passwd, switch_memory_pool_t *  pool )

Open a directory handle. Parameters: dh  a direcotry handle to use module_name  the directory module to use source  the source of the db (ip, hostname, path etc) dsn  the username or designation of the lookup passwd  the password pool  the pool to use (NULL for new pool) Returns: SWITCH_STATUS_SUCCESS if the handle is opened { switch_status_t status; if ((dh->directory_interface = switch_loadable_module_get_directory_interface(module_name)) == 0) { switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "invalid directory module [%s]!\n", module_name); return SWITCH_STATUS_GENERR; } if (pool) { dh->memory_pool = pool; } else { if ((status = switch_core_new_memory_pool(&dh->memory_pool)) != SWITCH_STATUS_SUCCESS) { return status; } switch_set_flag(dh, SWITCH_DIRECTORY_FLAG_FREE_POOL); } return dh->directory_interface->directory_open(dh, source, dsn, passwd); }

Here is the call graph for this function:

switch_status_t switch_core_directory_query (  switch_directory_handle_t *  dh, char *  base, char *  query )

Query a directory handle. Parameters: dh  a direcotry handle to use base  the base to query against query  a string of filters or query data Returns: SWITCH_STATUS_SUCCESS if the query is successful { return dh->directory_interface->directory_query(dh, base, query); }

---