EMS FastStart Manual

Building Your Application for Event Generation
EMS FastStart Manual–133701
6-7
Close^egen^collector
Close^egen^collector
The Close^egen^collector procedure is used to close the current collector file on behalf
of the user application. Example 6-5 shows the syntax for this procedure.
EGEN Parameters
EGEN internally detects the mode of operation by analyzing the combination of
parameters passed to it. There are four combinations of parameters which are valid for
EGEN. If you call EGEN with any other combination, an error message will be returned
to you. Table 6-2 shows the parameters that must be passed to EGEN for each operating
mode.
Example 6-5. Syntax for the Close^egen^collector Procedure
{ status := } CLOSE^EGEN^COLLECTOR ( collector^file^number ) ! i
{ CALL }
status returned value
INT
on return, is one of the following numbers:
0 No Error
<> 0 An error occurred when closing the collector.
Please refer to Appendix B for the list of
warnings or errors that can be returned by
this procedure.
collector^file^number
INT:value
is used to pass the filenumber to close.
Table 6-2. Parameters Required for Modes
Mode #
Name Passed 1234
egen-record YES YES YES YES
user-file-number NO YES YES NO
event-buffer-ptr NO NO YES YES
user-tag NO NO YES NO
event-buffer-length NO NO NO YES