The CENTRALSUPPORT library procedures return output parameters and procedure result values. The parameter types are further described on the following pages.
Input Parameters
In many cases, the input parameter requires the program to supply the ccsversion name or number, the language name, or the convention name. This information can be obtained in the following ways:
-
The MultiLingual System Administration, Operations, and Programming Guide describes all the possible ccsversions, languages, and conventions provided to you. However, the system on which the program is running might have only a subset of these. There can also be customized conventions that are not listed in the MultiLingual System Administration, Operations, and Programming Guide. These can be identified by the next two options.
-
A system administrator, a privileged user, or a person allowed to use the system console can use MARC menus and screens to list the options that exist on the system. The SYSTEMOPTIONS command can be used. For more information on the SYSTEMOPTIONS command, see the System Commands Reference. The MultiLingual System Administration, Operations, and Programming Guide provides additional instructions needed to obtain this information.
-
Procedures can be called in the CENTRALSUPPORT library that can return this information. If an application is being written to be used on another system, these library procedures can be used to verify that the ccsversion, language, or convention specified by the user is valid on that system.
For any procedure that accepts a ccsversion number as an input parameter, you can specify a –2 (or the constant value CCSVSNNOTSPECIFIEDV) as input to indicate that the system default value should be used. For any procedure that accepts a ccsversion name as an input parameter, you can specify all blanks or all zeros as inputs to indicate that the system default value should be used. For any procedure that accepts a language or convention name as an input parameter, you can specify all blanks or all zeros as inputs to indicate that the task attribute should be used. If the task attribute is not available, the CENTRALSUPPORT library searches down the hierarchy until a usable value is found.
Input Parameters with Type Values
Many of the CENTRALSUPPORT procedures have a parameter that indicates the type of information to be applied or returned by the procedure. The values in these parameters are referred to as type values. The values are common across all procedures of the library. The values used in the convention (CNV) procedures are common across all CNV procedures. The values used in the coded character set and ccsversion (VSN) procedures are common across all CCS and VSN procedures. The INCLUDE file contains DEFINES that map these constant integer type values to an identifier that can be used in your program.
For example, the TYP parameter is used in a number of procedures to indicate the type of date or time formatting to be used. The type value indicates the type of format to be used. For example, a value of 3 indicates the long time format. The DEFINE is CS_LTIMEV.
Output Parameters
These parameters contain the results of the procedure. For example, the DEST parameter of the CCSTOCCS_TRANS_TEXT procedure contains the translated text produced by the procedure. In the examples for each procedure described later in this section, not all output variables are printed. Representative output is shown.
Result
All the library procedures return an integer that indicates whether an error occurred during the execution of the procedure. A returned value of CS_DATAOKV (1) or CS_FALSEV (1001) means that no error occurred. However, the CNV_VALIDATENAME and VSNCOMPARE_TEXT procedures are exceptions to this rule. For these procedures, the returned value can be 0 (zero), 1, or another value. A returned value of 0 means that no error occurred and the condition is FALSE. A returned value of 1 means that no error occurred and the condition is TRUE. Any other value means that an error occurred.
Each procedure lists the values that can be returned by that procedure. The meanings of these values are explained at the end of this section. These results can be used to call the GET_CS_MSG procedure and to display the error that occurred, or error routines can be coded to handle the possible errors.
Refer to GET_CS_MSG for more information about using that procedure.
The INCLUDE file contains DEFINES that map each integer result into a define identifier to be used by your program.
