company logo

opai :: SetWorkDictionary - Set work dictionary

A work dictionary can be set, when the application works with a utility handle control block. Otherwise, no work dictionary is set and an invalid dictionary handle will be returned.

The function allows (re)setting the work dictionary. When a work dictionary has already been set, it will be re-opened, when the database handle path differs from the current work dictionary path.

Return value:  Dictionary handle ( DictionaryHandle & )

The dictionary handle usually refers to an opened dictionary. To check whether a dictionary is opened one may use the !-operator.

Implementation details

DictionaryHandle & opai  :: SetWorkDictionary ( DatabaseHandle &dbhandle_ref )

Whe it has been set successfully, the function returns the work dictionary. Otherwise an invalid dictionary handle.

  • dbhandle_ref - Reference to database handle