company logo

Application :: dictionary - Get application dictionary

When running utilities, the dictionary handle is the access handle for the dictionary handled by the utility. When running OShell or OSI, the application dictionary is the dictionary for the data source currently active.

Return value:  Dictionary handle ( odaba::Dictionary & )

The dictionary handle usually refers to an opened dictionary. Calling functions with invalid dictionary handles may cause an exception. For checking the dictionary handle, isValid() can be called.

Implementation details

odaba::Dictionary Application  :: dictionary (  )

The function provides a dictionary handle for the current context. When the function is called while running an OSI function or expression, the dictionary handle from the current environment will be returned (data source). Otherwise, the utility context is checked and when running a utility, the dictionary handle is returned from the utility data source.

When not running in a utility or OSI context, the function throws an exception.