DatabaseHandle :: OpenReplicate - Open replication database

The function opens a replication database by passing server name and port or by referring to an opened connection in the passed client handle.

Return value: Success ( logical )

Implementation overview

Open replication database by server name and port
DatabaseHandle :: OpenReplicate ( dicthdl_refc, cpath, local_path, accopt, w_netopt, server_name, port_number, key_buffer=NString::Null(), online_version=NO, sysenv=NO )
Open replication database by connection
DatabaseHandle :: OpenReplicate ( client_refc, dicthdl_refc, cpath, local_path, accopt, w_netopt, key_buffer=NString::Null(), online_version=NO, sysenv=NO )

Implementation details

Open replication database by server name and port
logical DatabaseHandle :: OpenReplicate ( DictionaryHandle &dicthdl_refc, NPath &cpath, NPath &local_path, PIACC accopt, logical w_netopt, NString &server_name, int32 port_number, NString &key_buffer=NString::Null(), logical online_version=NO, char sysenv=NO )
- dicthdl_refc - - internal feature (not documented)
- cpath - Complete file or directory path
- local_path - Path to local database replicate
- 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.
- server_name - Server name
- port_number - Port number
  The port number must be the same the server has been started with (e.g. 6123). When no port number is passed, the client expects the port number being defined in a system variable SERVER_PORT or in a system environment ini-file on the ODABA installation folder.
- key_buffer - - internal feature (not documented) Default: NString::Null()
- online_version - Online versioning option
  When this option is set the database will be enabled for on line versioning. When the option is set to NO the system variable ONLINE_VERSION is checked instead.
  Default: NO
- 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

to list

Open replication database by connection
logical DatabaseHandle :: OpenReplicate ( ODABAClient &client_refc, DictionaryHandle &dicthdl_refc, NPath &cpath, NPath &local_path, PIACC accopt, logical w_netopt, NString &key_buffer=NString::Null(), logical online_version=NO, char sysenv=NO )

Calling this function requires, that the client handle passed as odaba_client has already established a connection to a server.
- client_refc - Reference to client handle
- dicthdl_refc - - internal feature (not documented)
- cpath - Complete file or directory path
- local_path - Path to local database replicate
- 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.
- key_buffer - - internal feature (not documented) Default: NString::Null()
- online_version - Online versioning option
  When this option is set the database will be enabled for on line versioning. When the option is set to NO the system variable ONLINE_VERSION is checked instead.
  Default: NO
- 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

to list

to top Comment