EMS FastStart Manual

EMS FastStart Manual–133701
B-1
B
EGEN Messages
Each time you call one of the procedures implemented in the EGEN module you should
verify the value of the return code to determine whether or not an error occurred during
event generation. This appendix describes the return codes defined between EGEN and a
user application (implemented by EGEN as a set of TAL procedures).
A return code for each procedure implemented in the EGEN module informs the calling
application of the status of the operation requested. If the return code is equal to zero
(0), the operation was successful. If the return code is not equal to zero (0), it indicates a
warning or an error. Also, a special field called egen-error (integer) in the EGEN record
structure is used to give you more detailed information about the error. The contents of
this field depends on the return code of the EGEN procedures.
The following is a list of procedures for which error, warning, and advisory return codes
are returned to the calling application:
•
Initialize^egen^record (Initialize^egen^record Return Codes)
•
Open^egen^collector (Open^egen^collector Return Codes)
•
Close^egen^collector (Close^egen^collector Return Codes)
•
Complete^egen^operation (Complete^egen^operation Return Codes)
•
Get^egen^event^text^define (Get^egen^event^text^define Return Codes)*
•
Initialize^event^buffer (Initialize^event^buffer Return Codes)*
•
Write^event^buffer (Write^event^buffer Return Codes)*
•
EGEN (EGEN Return Codes)
*These procedures are not called directly by the user application but are called from
within EGEN.
Initialize^egen^record Return Codes
0: Egen-initialize-record-ok
Returned when the egen-record initializes properly. The value of egen-error has no
meaning for this message.
1: Egen-initialize-missing-param
Returned if this procedure is called without the egen-record parameters. The value of
egen-error has no meaning for this message.
Open^egen^collector Return Codes
0: Egen-open-collector-ok
Returned when the collector is opened. The value of egen-error has no meaning for this
message.