company logo

Application :: workDictionary - Get work dictionary

When the application is running as utility, the function returns the work dictionary. Utilities are ODABA framework applications (GUI), but also OShell and OSI calls. One may also create utility applications, when using the ODABA Utility Control Block for initializing and opening the database.

As work dictionary the database handle for the application is opened as dictionary. This, usually makes sense only, when the database opened in the application is a resource database. One may, however, also explicitly define another database handle as work dictionary.
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 overview

Implementation details

  1. Get work dictionary
    odaba::Dictionary & Application  :: workDictionary (  )

    The function returns the work dictionary, which is (by default) the dictionary created from the database handle (database handle as dictionary) defined in the utility control block.
    2. to list
  2. Set work dictionary
    odaba::Dictionary & Application  :: workDictionary ( odaba::Database &rDatabase )

    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.
    • rDatabase - Database handle

      The database handle refers to an (usually) opened database. Calling functions with invalid database handles may cause an exception. For checking the database handle, isValid() can be called.
    3. to list
to top previous next upper table of contents Comment