1 09/10/85  save_format_options, svfo
 2 
 3 Syntax:  svfo path {-format_option_args} {-control_args}
 4 
 5 
 6 Function:  saves the current values of format options as a subsystem
 7 exec_com.  The saved format can be restored with the
 8 restore_format_options request.  The file is saved by utilizing a
 9 suffix of fo.ec_name where ec_name is substituted by the subsystem's ec
10 suffix by the report writer.  Individual format options, active format
11 options, or all of the format options can be saved.  The requests used
12 to select the set of columns through the subsystem can also be saved.
13 
14 
15 Arguments:
16 path
17    is the pathname of the segment that contains the saved format.  If
18    path does not have an fo.ec_name suffix, one is assumed.
19 
20 
21 format_options_args
22    refer to the set_format_options request for a complete description
23    of the format option arguments.  Each format option named has its
24    value saved in the exec_com specified by path.  These arguments are
25    incompatible with the -all and -active control arguments.
26 
27    GENERAL REPORT OPTIONS
28       -delimiter, -dm
29       -format_document_controls, -fdc
30       -hyphenation, -hph
31       -page_footer_value, -pfv
32       -page_header_value, -phv
33       -page_length, -pl
34       -page_width, -pw
35       -title_line, -tl
36       -truncation, -tc
37 
38 
39    GENERAL COLUMN OPTIONS
40       -column_order, -co
41       -count, -ct
42       -exclude, -ex
43       -group, -gr
44       -group_footer_trigger, -gft
45       -group_footer_value, -gfv
46       -group_header_trigger, -ght
47       -group_header_value, -ghv
48       -outline, -out
49       -page_break, -pb
50       -row_footer_value, -rfv
51       -row_header_value, -rhv
52       -subcount, -sct
53       -subtotal, -stt
54       -total, -tt
55 
56 
57    SPECIFIC COLUMN OPTIONS
58       -alignment, -al
59       -editing, -ed
60       -folding, -fold
61       -separator, -sep
62       -title, -ttl
63       -width, -wid
64 
65 
66 Control arguments:
67    can be one or more of the following:
68 -active, -act
69    specifies that only the active formatting options are to be saved.
70    (Default) "help formatting_options.gi" is typed for more information
71    on active formatting options.  This control argument is incompatible
72    with the format option arguments and the -all control argument.  If
73    -active and -all are given, the last one supplied is used.
74    (Default)
75 
76 
77 -all, -a
78    specifies that all formatting options are to be saved.  This control
79    argument is incompatible with the format option arguments and the
80    -active control argument.  If -all and -active are given, the last
81    one supplied is used.
82 -query
83    specifies that the subsystem query request used to select the
84    columns is to be saved.  A restore_format_options on the saved
85    format also restores and makes the saved query current.
86 
87 
88 Examples:
89    svfo report_layout
90    svfo report_layout -all
91    svfo report_layout -query
92    svfo report_layout -page_header_value -page_footer_value
93    svfo report_layout -page_header_value -width salary
94    svfo report_layout -width ** -page_footer_value