PvGetDbDictionaryPath()

Distributed Tuning Interface Reference : PvGetDbDictionaryPath()

Retrieves the dictionary path (where DDF files reside) of a named database.

Header File: catalog.h (See also Header Files)

Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (macOS) (See also Link Libraries)

Syntax

BTI_API PvGetDbDictionaryPath(

BTI_LONG hConnection,

BTI_CHAR_PTR dbName,

BTI_ULONG_PTR pBufSize,

BTI_CHAR_PTR dictPath);

Arguments

In	hConnection	Connection handle that identifies the server. Connection handles are obtained with the PvConnectServer() function.
In	dbName	Name of the database. A list of all database names for a particular server is obtained with the PvGetDbNamesData() function. A single database name from the resulting list can be obtained with the PvGetDbName() function.
In/Out	pBufSize	Address of an unsigned long containing size of the buffer. Receives actual size of the path returned.
Out	dictPath	Contains the dictionary path if successful, or empty string otherwise.

Return Values

P_OK	The operation was successful.
P_E_INVALID_HANDLE	Invalid connection handle.
P_E_NULL_PTR	Call with NULL pointer
P_E_BUFFER_TOO_SMALL	The buffer is too small for the string. In this case, the required buffer size is returned in pBufSize.
P_E_NOT_EXIST	Named database does not exist.
P_E_FAIL	Failed for other reasons.

Remarks

The following precondition must be met:

•Connection established by PvConnectServer() or if you are performing the operation on a local machine, P_LOCAL_DB_CONNECTION may be used as the connection handle.