error_init(_c)
status.i4.v = error_init(error_row.i4.r, error_column.i4.r,
error_length.i4.r, write_log.i4.r
[,log_file.i1a.r] [,author.i1a.r]
[,num_rows.i4.r] [,use_manager.i4.r]
[,priority.i4.r] [,border_style.i4.r]
[,erase_timeout.i4.r] [,options.i4.r])
status.i4.v = error_init_c(error_row.i4.v, error_column.i4.v,
error_length.i4.v, write_log.i4.v
[,log_file.i1a.r] [,author.i1a.r]
[,num_rows.i4.v] [,use_manager.i4.v]
[,priority.i4.v] [,border_style.i4.v]
[,erase_timeout.i4.v] [,options.i4.v])
This routine initializes error display parameters.
error_row row location of message (If this value is negative,
error messages will only be logged, not displayed.)
(Pass a value of 1 when calling this routine from
a nonconsole environment, if messages are desired.)
error_column column location of message
error_length maximum number of characters
that would be used for error messages (13 minimum)
write_log log to which error messages will be copied
(LOG_NONE -> no log entries written,
LOG_PROGRAM -> log entries in the program log,
LOG_CONSOLE -> log entries in the console log,
LOG_BOTH -> log entries in both local and shared logs)
[log_file] log file name (LOG_NAMLEN characters)
(must be specified if "write_log" has a value of
LOG_PROGRAM or LOG_BOTH) (default is NULL)
[author] author string (LOG_AUTLEN characters)
(If this is specified, a log entry will be written
with this as the author string. Otherwise, the
default string is used.) (default is NULL)
[num_rows] number of rows in error display field (If this is
specified and has a value greater than one, a
scrolling message window will be created. If a
negative value is passed, a borderless scrolling
window will be created. This argument should only
have a value of 1 if the calling program is
running in a console graphic window environment.
For a non-console application, this arguments sets
the limit of error messages written. The default
is ERR_NONCNS_MESSAGE_LIMIT.)
(default is 1 which produces a nonwindow single
line display on the background window)
[use_manager] TV window I/O environment
(ERR_USE_WINDOW_MANAGER -> use TV window manager
routines (default),
ERR_USE_TV_ROUTINES -> use primitive TV routines)
(This argument is ignored if the calling program
is a Secondary Application (SA).)
[priority] priority of any log message written (The meaning of
a given priority is defined by the application.)
(default is ERR_DEFAULT_PRIORITY)
[border_style] error window border style
(WMNGR_BORDER_THIN -> thin lined border (default),
WMNGR_BORDER_THICK -> thick lined border)
(This argument is used only if the TV window manager
routines are used.)
[erase_timeout] number of seconds after displaying the last error
message to erase it (only used for single line
error displays) (default is ERR_NO_ERASE)
[options] error display options which can be ORed together
(ERR_OPT_ENABLE_ERROR_TEXT -> display complete text
descriptions of ACNET
errors (default),
ERR_OPT_DISABLE_ERROR_TEXT -> display facility text and
numeric error codes,
ERR_OPT_HORIZONTAL_SCROLL -> support horizontal
scrolling of error
messages)
This function returns ACNET status values as follows:
OK success
CBS_WINDOW_TOO_BIG window won't fit on screen
CBS_INVARG invalid number of rows passed or error
window requested for SA
This function requires the following include files:
cnsparam_h, cbslib_h, acnet_errors_h
Related functions:
error_display(_c), error_printf_c, error_message(_c), error_mprintf_c,
error_colored_message_c, error_cmprintf_c, error_move_enable,
error_move_disable, error_pop_window, error_erase, error_close,
error_imbedded_enabled, error_imbedded_on, error_imbedded_off,
error_query_setup, error_init_uti, error_size_and_position_c,
error_is_occluded, error_window_is_present, intro_error
C/C++ usage:
#define SCREEN_ROWS 24
#define SCREEN_COLUMNS 68
#define NROWS_ERR 4
#define ROW_ERR (SCREEN_ROWS - NROWS_ERR - (2 * WMNGR_BORDER_WIDTH) + 1)
#define COL_ERR 1
#define LEN_ERR (SCREEN_COLUMNS - (2 * WMNGR_BORDER_WIDTH))
static const char log_file[LOG_NAMLEN+1] = "XXXXXLOG";
static const char author[LOG_AUTLEN+1] = "Author";
int status;
int error_row = ROW_ERR;
int error_column = COL_ERR;
int error_length = LEN_ERR;
int write_log = LOG_BOTH;
int num_rows = NROWS_ERR;
int use_manager = ERR_USE_WINDOW_MANAGER;
int priority = ERR_DEFAULT_PRIORITY;
int border_style = WMNGR_BORDER_THIN;
int erase_timeout = ERR_NO_ERASE;
int options = ERR_OPT_ENABLE_ERROR_TEXT;
status = error_init_c(error_row,error_column,error_length,
write_log,log_file,author,num_rows,
use_manager,priority,border_style,
erase_timeout,options);