company logo

DictionaryHandle :: DictionaryHandle - Create dictionary handle

Usually the dictionary is created as local dictionary, i.e. the external dictionary must be provided in the local environment.

When the application tries to refer to databases on a server the dictionary has to be opened as server dictionary as well using the external dictionary on the server. In this case an ODABAClient with an opened connection has to be passed. When the connection is not opened the system tries to open the dictionary as local dictionary.

Implementation overview

Implementation details

  1. Copy constructor
    DictionaryHandle  :: DictionaryHandle ( DictionaryHandle &dictionary_refc )

    The function creates a new dictionary handle referring to the same dictionary handle as referred to in the passed dictionary.

    • dictionary_refc - Reference to dictionary handle
    2. to list
  2. Create dictionary for database handle
    DictionaryHandle  :: DictionaryHandle ( DatabaseHandle &dbhandle_refc )

    The function creates a dictionary object, which uses the resources from the database handle passed as db_handle.
    • dbhandle_refc - Reference to database handle
    3. to list
  3. Open dictionary handle for new dictionary object
    DictionaryHandle  :: DictionaryHandle ( ODABAClient &client_refc, NPath &cpath, PIACC accopt, logical w_netopt, ::ResourceTypes local_ressources=RES_automatic, char sysenv=NO, RootBase_Types rb_type=RBT_ODABA )

    The function creates a new dictionary object, which will be referred to by the dictionary handle.
    • client_refc - Reference to client handle
    • cpath - Complete file or directory path
    • accopt - Access mode
    • w_netopt - Multi-user option

      Passing this value as true (YES) indicates that multi-user access is requested. False (NO) indicates exclusive use of database. Accessing a database in update or write mode, NO guarantees absolute exclusive access.
    • local_ressources - Resource type

      Depending on the resource type the database or dictionary is opened on the client or server side.

      Default: RES_automatic
    • sysenv - System application

      This option indicates that the application is running as system application. In this case context functions are disabled and will not be executed. This option should never be set in normal applications because this may lead to logical inconsistency of the database.

      When running a replication client, this option contains the value 2. Running a replication client in a system application, the option contains the value 3.

      For maintenance purposes, 4 might be passed in the variable. In this case, versions will not be upgraded automatically.

             Default: NO
    • rb_type - - internal feature (not documented) Default: RBT_ODABA
    4. to list
  4. Dummy constructor
    DictionaryHandle  :: DictionaryHandle (  )
    5. to list
to top upper table of contents Comment