tc/emh.h File Reference

Detailed Description

This header defines the ITK interface to the Teamcenter error store.

Definition in file emh.h.

#include <tc/tc_startup.h>
#include <tc/libtc_exports.h>
#include <tc/libtc_undef.h>

Go to the source code of this file.

Defines

#define EMH_severity_information 1
#define EMH_severity_warning 2
#define EMH_severity_error 3
#define EMH_severity_user_error 4
#define EMH_MAXEMSG 1024
#define EMH_MAX_NUM_EMSG 100

Error severities

#define EMH_WARNING 1
#define EMH_SERIOUS 2
#define EMH_FATAL 3

Functions

TC_API int EMH_store_error (int severity, int ifail)
TC_API int EMH_store_error_s1 (int severity, int ifail, const char *s1)
TC_API int EMH_store_error_s2 (int severity, int ifail, const char *s1, const char *s2)
TC_API int EMH_store_error_s3 (int severity, int ifail, const char *s1, const char *s2, const char *s3)
TC_API int EMH_store_error_s4 (int severity, int ifail, const char *s1, const char *s2, const char *s3, const char *s4)
TC_API int EMH_store_error_s5 (int severity, int ifail, const char *s1, const char *s2, const char *s3, const char *s4, const char *s5)
TC_API int EMH_store_error_s7 (int severity, int ifail, const char *s1, const char *s2, const char *s3, const char *s4, const char *s5, const char *s6, const char *s7)
TC_API int EMH_store_initial_error (int severity, int ifail)
TC_API int EMH_store_initial_error_s1 (int severity, int ifail, const char *s1)
TC_API int EMH_store_initial_error_s2 (int severity, int ifail, const char *s1, const char *s2)
TC_API int EMH_store_initial_error_s3 (int severity, int ifail, const char *s1, const char *s2, const char *s3)
TC_API int EMH_store_initial_error_s4 (int severity, int ifail, const char *s1, const char *s2, const char *s3, const char *s4)
TC_API int EMH_store_initial_error_s5 (int severity, int ifail, const char *s1, const char *s2, const char *s3, const char *s4, const char *s5)
TC_API int EMH_ask_last_error (int *ifail)
TC_API int EMH_ask_errors (int *n_ifails, const int **severities, const int **ifails, const char ***texts)
TC_API int EMH_clear_errors (void)
TC_API int EMH_clear_last_error (int ifail)
TC_API int EMH_set_protect_mark (int *mark)
TC_API int EMH_clear_protect_mark (int mark)
TC_API int EMH_ask_error_text (int ifail, char **text)
TC_API int EMH_get_error_string (tag_t tag, int ifail, char **text)

Obsolete Functions

The following functions have never been publicly documented, however we are attempting to maintain their intended functionality for migration purposes. Please do not use these functions in any new code.

TC_API int EMH_get_error_codes (tag_t tag, int index_name, int max, int *codes)
TC_API int EMH_get_error_text (tag_t tag, int index_name, int max, char *msgs[])
TC_API int EMH_catch_ifail (int ifail)
TC_API int EMH_ask_initial_traceback (const char *separator, char **traceback)
TC_API void EMH_clear_initial_traceback (void)
TC_API void EMH_capture_initial_traceback (void)
TC_API void EMH_close_error_text_file (void)
TC_API char * EMH_ask_system_log (void)

Define Documentation

#define EMH_FATAL 3

Definition at line 36 of file emh.h.

#define EMH_MAX_NUM_EMSG 100

Definition at line 446 of file emh.h.

#define EMH_MAXEMSG 1024

Maximum size of error message

Definition at line 40 of file emh.h.

#define EMH_SERIOUS 2

Definition at line 35 of file emh.h.

#define EMH_severity_error 3

Definition at line 21 of file emh.h.

#define EMH_severity_information 1

Definition at line 19 of file emh.h.

#define EMH_severity_user_error 4

Definition at line 22 of file emh.h.

#define EMH_severity_warning 2

Definition at line 20 of file emh.h.

#define EMH_WARNING 1

Definition at line 34 of file emh.h.

Function Documentation

TC_API int EMH_ask_initial_traceback	(	const char *	separator,
		char **	traceback
	)

Report the earliest ERROR_raise and its associated traceback

Parameters:

separator	(I)
traceback	(OF)

TC_API char* EMH_ask_system_log ( void )

A routine to call ERROR_ask_system_log

TC_API void EMH_capture_initial_traceback ( void )

Copy our memory of any signals/ERROR_internals to the database, then clear it.

TC_API int EMH_catch_ifail ( int ifail )

Generate an ERROR_note when this ifail occurs.

Parameters:

ifail

(I)

TC_API void EMH_clear_initial_traceback ( void )

Clear our memory of any ERROR_raises

TC_API void EMH_close_error_text_file ( void )

A routine to force a re-open on the error text file

TC_API int EMH_get_error_codes	(	tag_t	tag,
		int	index_name,
		int	max,
		int *	codes
	)

If index is zero, this returns the error codes currently on the error store.

Note:: The error code are returned with the lowest-level error first. If index is non-zero, it returns just the index'th-1 error code.
This functions returns the number of errors it is giving back, NOT an ifail code as is normal for Teamcenter ITK.

Warning:: this routine expects you to have allocated space for int *codes yourself

Parameters:

tag	(I)
index_name	(I)
max	(I)
codes	(O)

TC_API int EMH_get_error_text	(	tag_t	tag,
		int	index_name,
		int	max,
		char *	msgs[]
	)

If index is zero, this returns the error messages currently on the error store.

Note:: The error messages are returned with the lowest-level error first. If index is non-zero, it returns just the index'th-1 error message.
This functions returns the number of errors it is giving back, NOT* an ifail code as is normal for Teamcenter ITK.

Warning:: this routine expects you to have allocates space for char* msgs[] to be a max array of pointers to space for error text to be strcpy'd to. You almost certainly want to call EMH_ask_errors instead

Parameters:

tag	(I)
index_name	(I)
max	(I)
msgs	(O)