PvCloseDictionary()
Closes an open dictionary.
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 PvCloseDictionary(
WORD dictHandle);
Arguments
In | dictHandle | Handle of an open or newly-created dictionary. |
Return Values
PCM_Success | The operation was successful. |
PCM_errFailed | The operation was not successful. |
PCM_errMemoryAllocation | An error occurred during memory allocation. |
PCM_errDictionaryNotOpen | The specified dictionary was not open. |
Remarks
This function requires a handle for an open dictionary file, which can be obtained with the
PvCreateDictionary() function.
Since multiple dictionaries can be open at one time, you need to call this function for every open or newly-created dictionary.
Example
PRESULT status = 0;
status = PvCloseDictionary(myDictionaryHandle);
See Also