Daylight v4.9
Release Date: 1 February 2008

Name

dt_getsearchpath - get the current database search path

Generic Prototype

dt_getsearchpath(dt_Handle) => dt_Handle

C Prototype

#include "dt_thor.h"

dt_Handle dt_getsearchpath(dt_Handle object)

FORTRAN Prototype

include 'dt_f_thor.inc'

integer*4 dt_f_getsearchpath(object)

integer*4 object

Description

Gets the current database search path as a sequence of strings. Each string contains and operating system-specific directory name which will be searched for databases. The order of the directories in the sequence of strings matches the order in which the directories are searched.

Note that the directory names are interpreted by the server. Hence, they will appear in a format appropriate for the server operating system. Environment variables, symbols, and logicals, need only be valid on the server, as they are interpreted on the server.

The calling application is responsible for deallocating the strings and sequence (the strings are not automatically deallocated when the sequence is deallocated).

Return Value

Returns a sequence of strings. For objects other than servers, this property is defined as NULL_OB.

Related Topics

dt_getdatabases(3) dt_getpasswords(3) dt_getusers(3) dt_server(3) dt_setsearchpath(3)