Request information on character sets
Component: | SPOOL |
Functional area: | Controlling spoolout job |
Domain: | SPOOL-PRINT-ADMINISTRATION |
Privileges: | STD-PROCESSING |
Routing code: | $ |
Function
The SHOW-SPOOL-CHARACTER-SETS command provides information on data from the specified character set. The number of character sets listed can be freely limited by specifying selection criteria. All those character sets are selected whose entry contains the values specified in the relevant operands (logical ANDing).
The SHOW-SPOOL-CHARACTER-SETS operands have the same names and meanings as the operands of the SPSERVE statement ADD-SPOOL-CHARACTER-SET. The operand value *ALL (usually the default) means that the respective operand will not be used as a selection criterion.
The command supports structured output in S variables (see "Output in S variables").
Format
SHOW-SPOOL-CHARACTER-SETS | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Operands
SELECT = *ALL / *PARAMETERS(...)
Specifies from what character sets information is to be output.
SELECT = *PARAMETERS(...)
Initiates a list of selection criteria.
CHARACTER-SET-NAME = *ALL / <alphanum-name 1..3 with-wild(24)>/ list-poss(255): *STD / <alphanum-name 1..3>
The selection criterion is the name of the character set. Specifying *STD designates the standard character set of the same name.
OWNER = *ALL / <alphanum-name 1..8 with-wild(24)> / list-poss(16): *NONE / *OWN / <name 1..8>
The selection criterion is the user ID of the user who created the character set.
Nonprivileged users may only specify *ALL or *OWN.
COLOUR = ALL / list-poss(9): *BLACK / *MAGENTA / *BLUE / *GREEN / *YELLOW / *CYAN / *RED / *NEUTRAL / *IGNORE
The selection criterion is the color.
WEIGHT = *ALL / list-poss(4): *LIGHT / *NORMAL / *BOLD / *IGNORE
The selection criterion is the line weight.
CHARACTER-TYPE = ALL / list-poss(16): *OCR-A / *OCR-B / *GOTHIC /*GRAPHIC / *NONE / *DATA / *COURIER / *FONT-1 / *FONT-2 / *FONT-3 / *FONT-4 / *FONT-5 / *FONT-6 / *FONT-7 / *FONT-8 /
*FONT-9 / *FONT-10 / *FONT-11 / *FONT-12 / *FONT-13 / *FONT-14 / *FONT-15 / *FONT-16 / *IGNORE
The selection criterion is the font.
CHARACTER-STYLE = *ALL / list-poss(3): *STRAIGHT / *ITALICS / *IGNORE
The selection criterion is the type size specified for the character set.
UNDERSCORE = *ALL / list-poss(3): *YES / *NO / *IGNORE
The selection criterion is whether underscoring has been specified for the character set.
CHARACTERS-PER-INCH = *ALL / <integer 1..100> / *IGNORE / *RANGE(...)
The selection criterion is the character density. (*IGNORE and <integer 1..100> are only available as of RSO2.2A.)
CHARACTERS-PER-INCH = *RANGE(...)
Specifies a value range. All character sets whose character density is within the specified range are output.
LOW = <integer 1..100>
Lower range limit.
HIGH = <integer 1..100>
Upper range limit.
LINES-PER-INCH = *ALL / list-poss(9): 3 / 4 / 6 / 8 / 10 / 12 / 15 / 20 / 24
The selection criterion is the line density.
LANGUAGE = *ALL / list-poss(16): *INTERNATIONAL / *ENGLISH / *USA / *BELGIAN / *FRENCH / *DUTCH / *GERMAN / *NORWEGIAN / *SWEDISH / *DANISH / *SPANISH / SWISS / ITALIAN / NONE / IGNORE / *ARABIC / *FARSI / *ISO-8859-1 / *ISO-8859-2 / *ISO-8859-3 / *ISO-8859-4 / *ISO-8859-5 /
*ISO-8859-6 /*ISO-8859-7 / *ISO-8859-8 / *ISO-8859-9
The selection criterion is the language specified for the character set.
NEAR-LETTER-QUALITY = *ALL / list-poss(3): *YES / *NO / *IGNORE
The selection criterion is the indicator for NLQ quality in the character set.
ACCESS-DATE = *ANY / *TODAY / *INTERVAL(...)
The selection criterion is the date of the last change or the last utilization within a print process. This date may be required as an additional criterion for the output of the form entry. It can be a specific date or a date range.
ACCESS-DATE = *TODAY
The last modification or change was performed on the current date.
ACCESS-DATE = *INTERVAL(...)
Specifies a date range.
FROM = 1950-01-01 / <date with-compl>
Earliest date in the date range.
TO = *TODAY / <date with-compl>
Latest date in the date range. The current date is set by default.
EXCEPT = *NONE / *PARAMETERS(...)
Specifies what character sets are to be excluded from the selection (i.e. not taken into account). Specifying NONE (the default) means the operand is not used as a selection criterion.
EXCEPT = *PARAMETERS(...)
Initiates a list of selection criteria.
CHARACTER-SET-NAME = *NONE / <alphanum-name 1..3 with-wild(24)> / list-poss(16): *STD / <alphanum-name 1..3>
The character sets with the specified characteristics are not to be taken into account. Specifying *NONE (the default) means the operand is not used as a selection criterion.
OWNER = *NONE / alphanum-name 1..8 with-wild(24)> / list-poss(16): *OWN / <name 1..8>
The character sets with the specified characteristics are not to be taken into account. Specifying *NONE (the default) means the operand is not used as a selection criterion.
Nonprivileged users may only specify values other than *NONE for OWNER if they specified SELECT=PARAMETERS(OWNER=*OWN) above.
SERVER-NAME = *HOME / <alphanum-name 1..8>
Specifies the server for which information is to be output.
CLUSTER-NAME = *LOCAL-CLUSTER / <alphanum-name 1..8>
Specifies the cluster for which information is to be output. Only BS2000 clusters can be specified.
Notes
The value *STD is supported for reasons of compatibility. Which parameter file is used by default as the information source depends on the operating mode (dynamic, static, from configuration, from command.)
If a SPOOL parameter file is assigned (statically or dynamically), this is the default source. If no parameter file is assigned, the default source is the SPOOL parameter file of the home system.
Return codes
(SC2) | SC1 | Maincode | Meaning |
---|---|---|---|
0 | CMD0001 | No error | |
2 | 0 | SPM0413 | No character set present |
2 | 0 | SPM0518 | No authorization |
1 | CMD0202 | Syntax error | |
32 | SCP0974 | System error. Command rejected | |
64 | SCP0975 | No authorization for command |
Output
C-S-NAME COLOUR WEIGHT CH-TYPE CH-STYLE UND CPI LPI LANGUAGE NLQ OWNER @@@@@@@@ @@@@@@ @@@@@@ @@@@@@@ @@@@@@@@ @@@ ### ## @@@@@@@@ @@@ @@@@@@@@ ACCESS-DATE : @@@@-@@-@@
Note
The value IGN (IGNORE) in the fields COLOUR, WEIGHT, CH-TYPE, CH-STYLE, UNDERSCORE, LANGUAGE, NLQ and CPI shows that the respective operand is not interpreted by RSO.
Meaning of the fields
The name in parentheses is the corresponding operand of the ADD-SPOOL-CHARACTER-SET command.
Output field | Meaning / Contents |
---|---|
ACCESS-DATE | Date of the last modification or utilization |
C-S-NAME(CHARACTER-SET-NAME) | Name of the character set |
COLOUR(COLOUR) | Color in which the character set is to be printed |
WEIGHT(WEIGHT) | Character weight |
CH-TYPE(CHARACTER-TYPE) | Font (OCR-A, OCR-B, ...) |
CH-STYLE(CHARACTER-STYLE) | Character style (STRAIGHT, ITALICS) |
UND(UNDERSCORE) | Underlining |
CPI(CHARACTERS-PER-INCH) | Character density |
LPI(LINES-PER-INCH) | Line density (in lines per inch) |
LANGUAGE(LANGUAGE) | Language for which the character set is intended (INTERNAT, ENGLISH, ...) |
NLQ(NEAR-LETTER-QUALITY) | The print quality for printing: YES/NO |
OWNER | Under TSOS: |
Output in S variables
Output information | Name of the S variable | T | Contents | Condition |
---|---|---|---|---|
Character set name | var(*LIST).CHAR-SET-NAME | S | ' ' | |
Character style used to print the character set | var(*LIST).CHAR-STYLE | S | *IGNORE | |
Character type used to print the character set | var(*LIST).CHAR-TYPE | S | *COURIER | |
Color used to print the character set | var(*LIST).COLOUR | S | *BLACK | |
Pitch (in characters per inch) | var(*LIST).CPI | S | *IGNORE | |
Language for which the character set it used | var(*LIST).LANG | S | *ARABIC | |
Time stamp | var(*LIST).LAST-ACCESS | S | *NONE | INF=*ALL |
Line spacing (in lines per inch) | var(*LIST).LPI | S | 3,4,6,8,10,12,15,20,24 | |
Near-letter quality (NLQ) printing | var(*LIST).NLQ | S | *IGNORE | |
User ID of the character set owner | var(*LIST).OWNER | S | ' ' | |
Underscore printed characters | var(*LIST).UNDERSCORE | S | *IGNORE | |
Character weight used to print the character set | var(*LIST).WEIGHT | S | *BOLD |
Examples
Output to SYSOUT
/show-spool-character-set char-set=2*
C-S-NAME COLOUR WEIGHT CH-TYPE CH-STYLE UND CPI LPI LANGUAGE NLQ OWNER 208 BLACK NORMAL DATA STRAIGHT NO 12 6 NONE NO TSOS ACCESS-DATE : 2016-12-29 224 BLACK NORMAL COURIER STRAIGHT NO 10 6 NONE NO TSOS ACCESS-DATE : 2016-12-29
Output in S variable
/declare-var var-name=out(type=*structure),multiple-elem=*list
/exec-cmd (show-spool-character-sets select=*par(char-set=2*)),
text-output=*none,structure-output=out
/show-var out,inf=*par(val=*c-literal,list-index=*yes)
OUT#1.CHAR-SET.NAME = '208' OUT#1.COLOUR = '*BLACK' OUT#1.WEIGHT = '*NORMAL' OUT#1.CHAR-TYPE = '*DATA' OUT#1.CHAR-STYLE = '*STRAIGHT' OUT#1.UNDERSCORE = '*NO' OUT#1.CPI = '12' OUT#1.LPI = '6' OUT#1.LANG = '*NONE' OUT#1.NLQ = '*NO' OUT#1.OWNER = 'TSOS' OUT#1.LAST-ACCESS = '2016-12-29' *END-OF-VAR OUT#2.CHAR-SET.NAME = '224' OUT#2.COLOUR = '*BLACK' OUT#2.WEIGHT = '*NORMAL' OUT#2.CHAR-TYPE = '*COURIER' OUT#2.CHAR-STYLE = '*STRAIGHT' OUT#2.UNDERSCORE = '*NO' OUT#2.CPI = '10' OUT#2.LPI = '6' OUT#2.LANG = '*NONE' OUT#2.NLQ = '*NO' OUT#2.OWNER = 'TSOS' OUT#2.LAST-ACCESS = '2016-12-29' *END-OF-VAR