PvCloseDictionary()
Chapter contents
Closes an open dictionary.
Header file: DDF.H
Requires: W3DBAV75.DLL or higher version
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 PvOpenDictionary() or PvCreateDictionary() functions.
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
PvStart()
PvOpenDictionary()
PvCreateDictionary()
PvStop()