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 212 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

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

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

Referenced by qof_cmd_xmlfile(), and qof_main_free().

Export filename, if any.

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

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

File containing data to upload, if any.

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

SQL file, if any.

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

Referenced by qof_main_free(), and qof_mod_sql_file().

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

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

Referenced by qof_main_moderate_query(), and qof_mod_sql().

The database to include with -d.

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

Referenced by qof_cmd_explain(), qof_cmd_xmlfile(), qof_main_free(), qof_main_moderate_query(), and qof_mod_database().

The database to exclude with -e.

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

Referenced by qof_cmd_xmlfile(), qof_main_moderate_query(), and qof_mod_exclude().

The category to include with -c.

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

Referenced by qof_main_free(), and qof_mod_category().

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

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

Referenced by qof_mod_time().

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

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

Referenced by qof_mod_time().

The input session.

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

Referenced by qof_cmd_xmlfile().

The query results session, for STDOUT or -w.

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

Referenced by qof_cmd_xmlfile(), qof_mod_compression(), qof_mod_convert_deprecated(), and qof_mod_encoding().

gboolean QofMain_s::error

general error, abort.

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

Referenced by qof_cmd_explain().

QofQuery* QofMain_s::query

The current QofQuery, converted from QofSqlQuery

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

Referenced by qof_main_moderate_query().

List of sql commands from a file.

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

Referenced by qof_main_moderate_query(), and qof_mod_sql_file().

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

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

Referenced by qof_cmd_xmlfile(), and qof_mod_compression().

const gchar* QofMain_s::encoding

The encoding string to pass to the backend.

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

Referenced by qof_cmd_xmlfile(), and qof_mod_encoding().

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

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

Referenced by qof_mod_convert_deprecated().

The current parameter type in the query.

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


The documentation for this struct was generated from the following file:

Generated on Wed Jul 2 14:17:53 2008 for gpe-expenses by  doxygen 1.5.6