QofMain_s Struct Reference
[QOF Command Line Interface]

#include <qof-main.h>


Detailed Description

The qof-main context struct.

Intended as a core type for QOF-based CLI programs, wrap your own context struct around qof_main_context

Definition at line 210 of file qof-main.h.

Data Fields

gchar * filename
gchar * write_file
gchar * input_file
gchar * sql_file
gchar * sql_str
gchar * database
gchar * exclude
gchar * category
QofTime * min_qt
QofTime * max_qt
QofSession * input_session
QofSession * export_session
gboolean error
QofQuery * query
GList * sql_list
gint64 gz_level
const gchar * encoding
gint64 convert
QofType param_type


Field Documentation

gchar* QofMain_s::filename

Input filename containing (usually) QSF XML data, if any.

Definition at line 213 of file qof-main.h.

Referenced by main(), pq_invoice_xmlfile(), qof_cmd_xmlfile(), and qof_main_free().

gchar* QofMain_s::write_file

Export filename, if any.

Definition at line 215 of file qof-main.h.

Referenced by pq_invoice_xmlfile(), qof_cmd_hotsync(), qof_cmd_xmlfile(), qof_main_free(), and qof_mod_write().

gchar* QofMain_s::input_file

File containing data to upload, if any.

Definition at line 217 of file qof-main.h.

Referenced by check_invoice_handler(), main(), pilot_database_open(), and qof_cmd_hotsync().

gchar* QofMain_s::sql_file

SQL file, if any.

Definition at line 219 of file qof-main.h.

Referenced by qof_main_free(), and qof_mod_sql_file().

gchar* QofMain_s::sql_str

The current SQL, overwritten each iteration if using a file.

Definition at line 222 of file qof-main.h.

Referenced by check_invoice_handler(), qof_main_moderate_query(), qof_main_run_sql(), and qof_mod_sql().

gchar* QofMain_s::database

The database to include with -d.

Definition at line 224 of file qof-main.h.

Referenced by check_invoice_handler(), main(), pilot_database_open(), qof_cmd_explain(), qof_cmd_hotsync(), qof_cmd_xmlfile(), qof_main_free(), qof_main_moderate_query(), and qof_mod_database().

gchar* QofMain_s::exclude

The database to exclude with -e.

Definition at line 226 of file qof-main.h.

Referenced by check_invoice_handler(), pilot_database_open(), qof_cmd_hotsync(), qof_cmd_xmlfile(), qof_main_moderate_query(), and qof_mod_exclude().

gchar* QofMain_s::category

The category to include with -c.

Definition at line 228 of file qof-main.h.

Referenced by build_database_list(), find_invoice_contact(), qof_main_free(), and qof_mod_category().

QofTime* QofMain_s::min_qt

Holds the converted -t field - minimum. Matches objects above min.

Definition at line 231 of file qof-main.h.

Referenced by build_database_list(), check_invoice_handler(), find_param_cb(), and qof_mod_time().

QofTime* QofMain_s::max_qt

Holds the converted -t field - maximum. Matches objects below max.

Definition at line 234 of file qof-main.h.

Referenced by find_param_cb(), and qof_mod_time().

QofSession* QofMain_s::input_session

The input session.

Definition at line 236 of file qof-main.h.

Referenced by check_invoice_handler(), find_invoice_contact(), main(), pilot_database_open(), pilot_error(), pq_invoice_xmlfile(), qof_cmd_hotsync(), qof_cmd_xmlfile(), qof_main_run_query(), and qof_main_run_sql().

QofSession* QofMain_s::export_session

The query results session, for STDOUT or -w.

Definition at line 238 of file qof-main.h.

Referenced by find_invoice_contact(), pilot_error(), pq_invoice_xmlfile(), qof_cmd_hotsync(), qof_cmd_xmlfile(), qof_main_run_query(), qof_mod_compression(), qof_mod_convert_deprecated(), and qof_mod_encoding().

gboolean QofMain_s::error

general error, abort.

Definition at line 240 of file qof-main.h.

Referenced by check_invoice_handler(), main(), pilot_app_unpack(), pilot_database_open(), pilot_error(), pilot_qof_pack(), pilot_qof_unpack(), qof_cmd_explain(), qof_cmd_hotsync(), and write_ent_cb().

QofQuery* QofMain_s::query

The current QofQuery, converted from QofSqlQuery

Definition at line 242 of file qof-main.h.

Referenced by build_database_list(), find_invoice_contact(), find_param_cb(), pq_invoice_xmlfile(), qof_cmd_hotsync(), qof_main_moderate_query(), qof_main_run_query(), and qof_main_run_sql().

GList* QofMain_s::sql_list

List of sql commands from a file.

Definition at line 244 of file qof-main.h.

Referenced by check_invoice_handler(), qof_main_moderate_query(), and qof_mod_sql_file().

gint64 QofMain_s::gz_level

Use compression (>0 <=9) or not (0)

Definition at line 246 of file qof-main.h.

Referenced by main(), pq_invoice_xmlfile(), qof_cmd_hotsync(), qof_cmd_xmlfile(), and qof_mod_compression().

const gchar* QofMain_s::encoding

The encoding string to pass to the backend.

Definition at line 248 of file qof-main.h.

Referenced by qof_cmd_xmlfile(), and qof_mod_encoding().

gint64 QofMain_s::convert

If the application needs to read QOF_TYPE_DATE data records, set this to non-zero.

Definition at line 251 of file qof-main.h.

Referenced by qof_mod_convert_deprecated().

QofType QofMain_s::param_type

The current parameter type in the query.

Definition at line 253 of file qof-main.h.

Referenced by build_database_list(), and find_param_cb().


The documentation for this struct was generated from the following file:
Generated on Tue Mar 6 00:08:10 2007 for pilot-qof by  doxygen 1.5.1