company logo

DataSource :: openDictionary - Open dictionary handle

The dictionary handle is opened only when a dictionary path has been defined. If another dictionary had already been opened, it is closed (closeDictionary()) before.

When the data source client is an object server client, the dictionary will be opened as local database, as long as the dictionary path is a local file path. In order to open a server dictionary, a symbolic path name has to be set in the dictionaryPath option (e.g. %SampleDict%).

In case of replication server, a local path is required for the 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. Open dictionary with access mode
    odaba::Dictionary & DataSource  :: openDictionary ( odaba::AccessModes eAccessMode )

    Usually, the dictionary is opened for read-only (Read). In order to allow updates in a dictionary database, Write can be passed in eAccessMode.

    • eAccessMode - Access mode

      Access mode for a property handle or database.

  2. to list
  3. Open dictionary for read-only
    odaba::Dictionary & DataSource  :: openDictionary (  )

    The function opens the dictionary in read-only mode.

  4. to list