z/OS Language Environment Concepts Guide
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Language Environment callable services

z/OS Language Environment Concepts Guide
SA38-0687-00

Naming conventions of the callable services are as follows:
  • Services starting with CEE are intended to be cross-system consistent; they operate on z//OS systems.
  • Services starting with CEE3 are services that exploit unique characteristics of z/OS® systems..
Table 1. Language Environment callable services
Service name Description
Communicating conditions services
CEEDCOD (Decompose a condition token) Decomposes an existing condition token.
CEENCOD (Construct a condition token) Dynamically constructs a condition token. The condition token communicates with message services, condition management, Language Environment callable services, and user applications.
Condition handling services
CEE3CIB (Return pointer to condition information block) Given a condition token that is passed to a user-written condition handler, CEE3CIB returns a pointer to the condition information block associated with a condition. Allows access to detailed information about the subject condition during condition handling.
CEE3GRN (Get name of routine that incurred condition) Obtains the name of the routine that is running when a condition is raised. If there are nested conditions, the most recently signaled condition is used.
CEE3GRO (Return offset) Returns the offset of the location within the most current Language Environment-conforming routine where a condition occurred.
CEE3SPM (Query and modify Language Environment hardware condition enablement) Allows the user to manipulate the program mask by enabling or masking hardware interrupts.
CEE3SRP (Set resume point) Sets a resume point within user application code to resume from a Language Environment user condition handler.
CEEGQDT (Retrieve q_data_Token) Retrieves the q_data token from the instance-specific information (ISI) to be used by user condition handlers.
CEEHDLR (Register a user condition handler) Registers a user condition handler for the current stack frame.
CEEHDLU (Unregister a user condition handler) Unregisters a user condition handler for the current stack frame.
CEEITOK (Return initial condition token) Returns the initial condition token for the current condition.
CEEMRCE (Resume user routine) Resumes execution of a user routine at the location that is established by CEE3SRP.
CEEMRCR (Move resume cursor relative to handle cursor) Moves the resume cursor. You can either move the resume cursor to the call return point of the routine that registered the executing condition handler, or move the resume cursor to the caller of the routine that registered the executing condition handler.
CEESGL (Signal a condition) Signals a condition to the Language Environment condition manager. It also can be used to provide qualifying data and create an instance-specific information (ISI) field. The ISI contains information that is used by the Language Environment condition manager to identify and react to conditions.
Date and time services
CEECBLDY (Convert date to Cobol Lilian format) Converts a string representing a date into a COBOL Lilian date format. The COBOL Lilian date format represents a date as the number of days since 31 December 1600.
CEEDATE (Convert Lilian date to character format) Converts a number representing a Lilian date to a date written in character format. The output is a character string such as 1992/07/25.
CEEDATM (Convert seconds to character timestamp) Converts a number representing the number of seconds since 00:00:00 14 October 1582 to a character format. The format of the output is a character string, such as "1992/07/26 20:37:00."
CEEDAYS (Convert date to Lilian format) Converts a string representing a date into a Lilian format. The Lilian format represents a date as the number of days since 14 October 1582, the beginning of the Gregorian calendar.
CEEDYWK (Calculate day of week from Lilian date) Calculates the day of the week on which a Lilian date falls. The day of the week is returned to the calling routine as a number between 1 and 7.
CEEGMT (Get current Greenwich mean time) Returns the current Greenwich Mean Time (GMT) as both a Lilian date and as the number of seconds since 00:00:00 14 October 1582. These values are compatible with those generated and used by the other Language Environment date and time services.
CEEGMTO (Get offset from Greenwich mean time to local time) Returns values to the calling routine which represent the difference between the local system time and Greenwich Mean Time.
CEEISEC (Convert integers to seconds) Converts separate binary integers representing year, month, day, hour, minute, second, and millisecond to a number representing the number of seconds since 00:00:00 14 October 1582. Use CEEISEC instead of CEESECS when the input is in numeric format rather than character format.
CEELOCT (Get current local time) Returns the current local time in three formats:
  • Lilian date (the number of days since 14 October 1582)
  • Lilian timestamp (the number of seconds since 00:00:00 14 October 1582)
  • Gregorian character string (in the form YYYYMMDDHHMISS999)
CEEQCEN (Query the century window) Queries the century within which Language Environment assumes 2-digit year values lie. Use it with CEESCEN when it is necessary to save and restore the current setting.
CEESCEN (Set the century window) Sets the century where Language Environment assumes 2-digit year values lie. Use it with CEEDAYS or CEESECS when you process date values that contain 2-digit years (for example, in the YYMMDD format), or when the Language Environment default century interval does not meet the requirements of a particular application.
CEESECI (Convert seconds to integers) Converts a number representing the number of seconds since 00:00:00 14 October 1582 to seven separate binary integers representing year, month, day, hour, minute, second, and millisecond. Use CEESECI instead of CEEDATM when the output is needed in numeric format rather than character format.
CEESECS (Convert timestamp to number of seconds) Converts a string representing a timestamp into a number representing the number of seconds since 00:00:00 14 October 1582. This service makes it easier to do time arithmetic, such as calculating the elapsed time between two timestamps.
CEEUTC (Get Coordinated Universal Time) CEEUTC is an alias of CEEGMT.
Dynamic storage services
CEECRHP (Create new additional heap) Defines additional heaps. The heaps defined by CEECRHP can be used just like the Language Environment initial heap (heap id of 0). However, the entire heap created by CEECRHP may be quickly freed with a single call to the CEEDSHP (discard heap) service.
CEECZST (Reallocate storage) Changes the size of a previously allocated storage element while preserving its contents. Reallocation of a storage element is accomplished by allocating a new storage element of a new size and copying the contents of the old element to the new element.
CEEDSHP (Discard heap) Discards an entire heap that you created previously with a call to CEECRHP.
CEEFRST (Free heap storage) Frees storage previously allocated by CEEGTST. It can be used to free both large and small blocks of storage efficiently because freed storage is retained on a free chain instead of being returned to the operating system.
CEEGTST (Get heap storage) Allocates storage from a heap whose ID you specify. It can be used to efficiently acquire both large and small blocks of storage.
General services
CEE3DLY (Suspend processing of an active enclave in seconds) Suspends processing of an active enclave for a specified number of seconds up to a maximum of one hour.
CEE3DMP (Generate dump) Generates a dump of the runtime environment of Language Environment and of the member language libraries. The dump can be modified to selectively include such information as number and contents of enclaves and threads, traceback of all routines on a call chain, file attributes, and variable, register, and storage contents.
CEE3INF (Provide enclave information) Provides current Language Environment® information about the enclave.
CEETDLI (Invoke IMS™) Invokes IMS.
CEE3RPH (Set report heading) Sets the heading that is displayed at the top of the storage or runtime options report. Language Environment generates the storage report when the RPTSTG(ON) runtime option is specified, and the options report when the RPTOPTS(ON) runtime option is specified.
CEE3USR (Set or query user area fields) Sets or queries one of two 4-byte fields in the enclave data block known as the user area fields. The user area fields are associated with an enclave and are maintained on an enclave basis. A user area might be used by vendor or applications to store a pointer to a global data area or keep a recursion counter.
CEEDLYM (Suspend processing of an active enclave in milliseconds) Suspends processing of an active enclave for a specific number of milliseconds up to a maximum of one hour.
CEEENV (Query, set, or delete environment variables) Allows for querying, setting, and deleting of environment variables.
CEEGPID (Retrieve the Language Environment version and platform ID) Retrieves the Language Environment version ID and the platform ID of the version and platform of Language Environment that is in use for processing the currently active condition.
CEEGTJS (Retrieves the value of an exported JCL symbol) Retrieves and returns to the caller the length of an exported JCL symbol value or the symbol value.
CEERAN0 (Calculate uniform random numbers) Generates a sequence of uniform pseudo-random numbers between 0 and 1 using the multiplicative congruential method with a user-specified seed.
CEETEST (Invoke Debug Tool) Invokes a debug tool, such as Debug Tool.
Initialization and termination services
CEE3ABD (Terminate enclave with an abend) Requests Language Environment to terminate the enclave via an abend. The abend can be issued either with or without cleanup.
CEE3AB2 (Add a reason code to an abend) Supports the addition of a reason code to the ABEND. This enhances CEE3ABD to allow for more control of diagnostic information collection.
CEE3GRC (Get the enclave return code) Retrieves the current value of the user enclave return code.
CEE3PRM (Query parameter string) Returns to the calling routine the parameter string that was specified at invocation of the program. The returned parameter string contains only user parameters. If no user parameters are available, a blank string is returned.
CEE3PR2 (Supports longer parameter lists) Supports longer parameter lists.
CEE3SRC (Set the enclave return code) Modifies the user enclave return code. The value set is used in the calculation of the final enclave return code at enclave termination.
Locale callable services
CEEFMON (Format monetary string) Converts numeric values to monetary strings.
CEEFTDS (Format time and date into character string) Converts time and date specifications into a character string.
CEELCNV (Query locale numeric conventions) Returns information about the LC_NUMERIC and LC_MONETARY categories of the locale.
CEEQDTC (Query locale date and time conventions) Queries the locale's date and time conventions.
CEEQRYL (Query active locale environment) Allows the calling routine to query the current locale.
CEESCOL (Compare collation weight of two strings) Compares two character strings that are based on the collating sequence that is specified in the LC_COLLATE category of the locale.
CEESETL (Set locale operating environment) Allows an enclave to establish a global operating environment. An enclave's National Language operating environment determines the behavior of character collation, character classification, date and time formatting, numeric punctuation, and message response.
CEESTXF (Transform string characters into collation weights) Transforms each character in a character string into its collation weight and returns the length of the transformed string.
Mathematical services

Language Environment math services are scalar routines. x is a data type variable.

CEESxABS Absolute value
CEESxACS Arccosine
CEESxASN Arcsine
CEESxATH Hyperbolic arctangent
CEESxATN Arctangent
CEESxAT2 Arctangent x/y
CEESxCJG Conjugate of complex
CEESxCOS Cosine
CEESxCSH Hyperbolic cosine
CEESxCTN Cotangent
CEESxDIM Positive difference
CEESxDVD Floating complex divide
CEESxERF Error function
CEESxEXP Exponential (base e)
CEESxGMA Gamma function
CEESxIMG Imaginary part of complex
CEESxINT Truncation
CEESxLGM Log gamma function
CEESxLG1 Logarithm base 10
CEESxLG2 Logarithm base 2
CEESxLOG Logarithm base e
CEESxMLT Floating complex multiply
CEESxMOD Modular arithmetic
CEESxNIN Nearest integer
CEESxNWN Nearest whole number
CEESxSGN Transfer of sign
CEESxSIN Sine
CEESxSNH Hyperbolic sine
CEESxSQT Square root
CEESxTAN Tangent
CEESxTNH Hyperbolic tangent
CEESxXPx Exponentiation
Message handling services
CEECMI (Store and load message insert data) Stores the message insert data and loads the address of that data into the instance-specific information (ISI) field that is associated with the condition that is being processed after optionally creating an ISI.
CEEMGET (Get a message) Retrieves, formats, and stores a message in a buffer for manipulation or output by the caller.
CEEMOUT (Dispatch a message) Dispatches a message to a destination which you specify.
CEEMSG (Get, format, and dispatch a message) Gets/formats/dispatches a message corresponding to an input condition token received from a callable service. You can use this service to print a message after a call to any Language Environment service that returns a condition token.
National Language Support services
CEE3CTY (Set default country) Allows the calling routine to change or query the current national country setting. The country setting affects the date format, the time format, the currency symbol, the decimal separator character, and the thousands separator.
CEE3LNG (Set national language) Allows the calling routine to change or query the current national language. The national languages can be recorded on a LIFO national language stack. Changing the national language changes the languages of error messages, the names of the days of the week, and the names of the months.
CEE3MCS (Obtain default currency symbol) Returns the default currency symbol for the country specified.
CEE3MDS (Obtain default decimal separator) Returns the default decimal separator for the country specified.
CEE3MTS (Obtain default thousands separator) Returns the default thousands separator for the country specified.
CEEFMDA (Obtain default date format) Returns to the calling routine the default date picture string for a specified country.
CEEFMDT (Obtain default date and time format) Returns to the calling routine the default date and time picture strings for the country specified.
CEEFMTM (Obtain default time format) Returns to the calling routine the default time picture string for the country specified.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014