PvOpenDictionary()

Developer Reference : Platform Management : Distributed Tuning Interface (DTI) Guide : Distributed Tuning Interface Reference : PvOpenDictionary()

PvOpenDictionary()

Opens an existing dictionary. Given an absolute path of the dictionary or data source names, it returns a dictionary handle that will be used for any subsequent calls to any functions.

Note This function is deprecated in Zen 9 and higher versions. See PvOpenDatabase() to replace this function in your application.

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

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

Syntax

PRESULT PvOpenDictionary(

LPTSTR path,

WORD* dictHandle,

LPSTR user,

LPSTR password);

Arguments

In	path	Fully-qualified path to the dictionary files.
Out	dictHandle	Handle to be used in subsequent calls
In	user	User name needed to open the dictionary. This argument can be set to NULL.
In	password	Used in conjunction with user name to open the dictionary files. Can also be NULL.

Return Values

PCM_Success	The operation was successful.
PCM_errFailed	The operation was not successful.
PCM_errMemoryAllocation	An error occurred during memory allocation.
PCM_errDictionaryPathNotFound	The specified dictionary path is invalid.
PCM_errDictionaryAlreadyOpen	The specified dictionary files are currently open.
PCM_SessionSecurityError	Either the user name or password is invalid.

Remarks

This function should be called first when accessing DDFs via DTI.

Multiple dictionaries can be open at one time.

Use PvCloseDictionary() to free the resources.