company logo

DataSource :: dictionary - Dictionary handle

When the data source handle has been opened successfully, this handle refers to the opened 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 dictionary handle
    odaba::Dictionary & DataSource  :: dictionary (  )

    The function returns the dictionary handle for the data source. The dictionary handle might be invalid, when the data source has not been opened or has not been opened successfully.

  2. to list
  3. Set dictionary
    odaba::Dictionary & DataSource  :: dictionary ( odaba::Dictionary &cDictionary )

    The function allows changing the current dictionary for the data source by setting the passed dictionary (rDictionary) as current dictionary for the data source. If a dictionary is already opened for the data source, it will be closed (closeDictionary()) before setting the new dictionary.

    The function also sets the dictionary path in the data source to the dictionary path extracted from the passed dictionary handle (rDictionary.path()).

    • cDictionary - Dictionary handle

      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.

  4. to list