RW_PARSEMSG

Parse message to send to the XCALL interface

xcall RW_PARSEMSG(message, [def_file], [chain_file], [main_file], [text_file], [msg_file], 
&     [lib_file], [rend_file], [report], [output_location], [output_file], [output_format], 
&     [page_header], [separator][, link_file])

Arguments

message

Returned with the message you want to map to the new XCALL argument structure. (a)

def_file

(optional) Returned with the name of the report definition file. (a)

chain_file

(optional) Returned with the name of the program that ReportWriter should chain to upon termination. (a)

main_file

(optional) Returned with the name of the repository main file to use. (a)

text_file

(optional) Returned with the name of the repository text file to use. (a)

msg_file

(optional) Returned with the name of the text message file to use. (a)

lib_file

(optional) Returned with the name of the ReportWriter window library to use. (a)

rend_file

(optional) Returned with the name of the renditions file to use. (a)

report

(optional) Returned with the name of an existing report to be output. (a)

output_location

(optional) Returned with the output location as follows: (n)

0 = Output goes to the screen. (default)

1 = Output goes to the printer.

2 = Output goes to a file.

output_file

(optional) Returned with the name of the output file to generate if you specified an output_location value of 2. (a)

output_format

(optional) If you specified an output_location value of 2, returned with the output format as follows: (n)

0 = Output is generated in report form (including headers, footers, and the like). (default)

1 = Output consists of detail record data only. (See Generating a report to a file for more information on the available output formats.)

2 = ReportWriter generates a report in spreadsheet format.

page_header

(optional) Returned with a flag to indicate whether a spreadsheet has a page header generated as the first record of the report. Use only if output_format is 2. (n)

0 = No page header will be generated. (default)

1 = Page header will be generated.

separator

(optional) Returned with a flag that indicates the separator used for spreadsheet output. Use only if output_format is 2. Valid values are as follows: (n)

1 = Comma (default)

2 = Tab

3 = Space

4 = Semicolon

link_file

(optional) Returned with the name of the name link file to use. (a)

Discussion

RW_PARSEMSG provides a migration path from spawning or chaining to ReportWriter’s external subroutine interface (XCALL interface). It takes the message you’ve passed to ReportWriter or the value of the RPTUSR environment variable and translates it into a set of parameters to send to the interface.

The external subroutine interface does not support the chain_file and msg_file arguments. To chain to another file when ReportWriter terminates, you must STOP to the program name that you pass to RW_PARSEMSG. To specify a text message file for ReportWriter to use, you must pass the filename to U_START as the seventh argument.

You are not required to call U_START or %RW_INIT before calling RW_PARSEMSG.