a_remote_sql structure

Holds information needed for the dbremote utility using the DBTools library.

• apply a_bit_field
  Normally set TRUE.
• argv char **
  Pointer to a parsed command line (a vector of pointers to strings).
• batch a_bit_field
  When set TRUE, force exit after applying message and scanning log (this is the same as at least one user having 'always' send time).
• confirmrtn MSG_CALLBACK
  Address of a confirmation request callback routine or NULL.
• connectparms char *
  Parameters needed to connect to the database.
• debug a_bit_field
  When set TRUE, debug output is included.
• debug_dump_size a_sql_uint32
  Reserved for internal use and must set to 0.
• debug_page_offsets a_bit_field
  Reserved for internal use and must set to FALSE.
• default_window_title char *
  A pointer to the default window title string.
• deleted a_bit_field
  Normally set TRUE.
• encryption_key char *
  Pointer to an encryption key. Corresponds to the dbremote -ek option.
• errorrtn MSG_CALLBACK
  Address of an error message callback routine or NULL.
• frequency a_sql_uint32
  Reserved for internal use and must set to 0.
• full_q_scan a_bit_field
  Reserved for internal use and must set to FALSE.
• include_scan_range char *
  Reserved for internal use and must set to NULL.
• latest_backup a_bit_field
  When set TRUE, only logs that are backed up are processed.
• link_debug a_bit_field
  When set TRUE, debugging will be turned on for links.
• locale char *
  Reserved for internal use and must set to NULL.
• log_file_name const char *
  Pointer to the name of the DBRemoteSQL output log to which the message callbacks print their output.
• log_size a_sql_uint32
  DBRemoteSQL renames and restarts the online transaction log when the size of the online transaction log is greater than this value.
• logrtn MSG_CALLBACK
  Pointer to a function that prints the given message to a log file.
• max_length a_sql_uint32
  Set to the maximum length (in bytes) a message can have.
• memory a_sql_uint32
  Set to the maximum size (in bytes) of memory buffers to use while building messages to send.
• mirror_logs char *
  Pointer to the name of the directory containing offline mirror transaction logs.
• more a_bit_field
  This should be set to TRUE.
• msgqueuertn MSG_QUEUE_CALLBACK
  Function called by DBRemoteSQL when it wants to sleep.
• msgrtn MSG_CALLBACK
  Address of an information message callback routine or NULL.
• no_user_interaction a_bit_field
  When set TRUE, no user interaction is requested.
• operations a_sql_uint32
  This value is used when applying messages.
• patience_retry a_sql_uint32
  Set this to the number of polls for incoming messages that DBRemoteSQL should wait before assuming that a message it is expecting is lost.
• progress_index_rtn SET_PROGRESS_CALLBACK
  Pointer to a function that updates the state of the progress bar.
• progress_msg_rtn MSG_CALLBACK
  Pointer to a function that displays a progress message.
• queueparms char *
  Reserved for internal use and must set to NULL.
• receive a_bit_field
  When set TRUE, messages are received.
• receive_delay a_sql_uint32
  Set this to the time (in seconds) to wait between polls for new incoming messages.
• remote_output_file_name char *
  Pointer to the name of the DBRemoteSQL remote output file.
• rename_log a_bit_field
  When set TRUE, logs are renamed and restarted (DBRemoteSQL only).
• resend_urgency a_sql_uint32
  Set the time (in seconds) that DBRemoteSQL waits after seeing that a user needs a rescan before performing a full scan of the log.
• scan_log a_bit_field
  Reserved for internal use and must set to FALSE.
• send a_bit_field
  When set TRUE, messages are sent.
• send_delay a_sql_uint32
  Set the time (in seconds) between scans of the log file for new operations to send.
• set_window_title_rtn SET_WINDOW_TITLE_CALLBACK
  Pointer to a function that resets the title of the window (Windows only).
• threads a_sql_uint32
  Set the number of worker threads that should be used to apply messages.
• transaction_logs char *
  Should identify the directory with offline transaction logs (DBRemoteSQL only).
• triggers a_bit_field
  This should usually be cleared (FALSE) in most cases.
• truncate_remote_output_file a_bit_field
  When set TRUE, the remote output file is truncated rather than appended to.
• unused a_bit_field
  Reserved for internal use and must set to FALSE.
• use_hex_offsets a_bit_field
  When set TRUE, log offsets are shown in hexadecimal notation; otherwise decimal notation is used.
• use_relative_offsets a_bit_field
  When set TRUE, log offsets are displayed as relative to the start of the current log file.
• verbose a_bit_field
  When set, extra information is produced.
• version unsigned short
  DBTools version number (DB_TOOLS_VERSION_NUMBER).
• warningrtn MSG_CALLBACK
  Pointer to a function that displays the given warning message.