Distributed Tuning Interface Reference : PvCreateDictionary()
 
PvCreateDictionary()
Creates a new set of dictionary files. Given a fully-qualified path for the dictionary, it returns a dictionary handle that will be used for any subsequent calls to catalog functions.
Note This function is deprecated in PSQL 9 and higher versions. See PvCreateDatabase() and 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 PvCreateDictionary(
   LPCSTR          path,
   WORD*           dictHandle,
   LPCSTR          user,
   LPCSTR          password);
Arguments
 
In
path
Fully-qualified path to the dictionary files.
Out
dictHandle
Handle to be used in subsequent calls
In
user
User name used with the new dictionary. This argument can be set to NULL.
In
password
Used in conjunction with user name to create new 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_errPathNotFound
The specified path is invalid.
PCM_errSessionSecurityError
Either the user name or password is invalid.
PCM_errDictionaryAlreadyExists
A set of ddf files already exists at the specified location.
Remarks
Use PvCloseDictionary() to free the resources.
See Also
PvStart()
PvOpenDatabase()
PvGetDbDictionaryPath()
PvCloseDictionary()
PvStop()