For the latest information on upgrading to and from any versions of CICS TS, see CICS TS V5.6.

Changed API commands

Some API commands are extended with new options or RESP2 values. Also, the usage of certain options on existing API commands has changed. Check the new descriptions to ensure that you are using these options in the best way.

ASSIGN

New options ERRORMSG and ERRORMSGLEN on the ASSIGN command return the error message for the CICS task:
Start of changeERRORMSG(data-area) End of change
Start of changeReturns the error message up to a maximum of 500 bytes that is currently referenced in the transaction abend control block for the CICS task. Following a failure of a DPL request, the message is that returned from the remote system. For messages shorter than 500 bytes the message is padded with nulls.

If no message is present, the 500 byte area contains nulls.

End of change
Start of changeERRORMSGLEN(data-area) End of change
Start of changeReturns a halfword binary value representing the length of the message returned for ERRORMSG. If the message referenced in the transaction abend control block exceeds 500 bytes, the message is truncated and the length is set to 500.

If no message is present the length returned is 0.

End of change
The new option LINKLEVEL on the ASSIGN command returns the program link level:
Start of changeLINKLEVEL(data-area) End of change
Start of changeReturns a halfword binary value representing the program link level in the local system. The topmost link level is level one and for each EXEC CICS LINK the link level is incremented by one. The link level is not incremented for a language CALL statement. If a program is the target of a DPL request, the link level returned is that within the CICS region it is executing and not the wider distributed transaction. If a program is DPLed to, then link level one will be the CICS mirror program DFHMIRS.End of change
New options APPLICATION, MAJORVERSION, MICROVERSION, MINORVERSION, OPERATION and PLATFORM on the ASSIGN command return the current application context associated with the task:
Start of changeAPPLICATION (data-area)End of change
Start of changeReturns the 64 character name of the Start of changecurrent End of changeapplication associated with the task. It is part of the application context that is made up of the application name, the platform name, the operation name and the major, minor and micro version number of the application. If there is no application context associated with the task, then blanks are returned. End of change
Start of changeMAJORVERSION(data-area)End of change
Start of changeReturns the fullword binary value representing the major version of the Start of changecurrent End of changeapplication associated with the task, which is part of the application context. If there is no application context associated with the task, then -1 is returned.End of change
Start of changeMICROVERSION(data-area)End of change
Start of changeReturns the fullword binary value representing the micro version of the Start of changecurrent End of changeapplication associated with the task, which is part of the application context. If there is no application context associated with the task, then -1 is returned.End of change
Start of changeMINORVERSION(data-area)End of change
Start of changeReturns the fullword binary value representing the minor version of the Start of changecurrent End of changeapplication associated with the task, which is part of the application context. If there is no application context associated with the task, then -1 is returned.End of change
Start of changeOPERATION(data-area)End of change
Start of changeReturns the 64 character name of the Start of changecurrent End of changeoperation associated with the task, which is part of the application context. If there is no application context associated with the task, then blanks are returned.End of change
Start of changePLATFORM(data-area)End of change
Start of changeReturns the 64 character name of the platform associated with the task, which is part of the application context. If there is no application context associated with the task, then blanks are returned.End of change

For more information see ASSIGN.

DELAY

The DELAY command has been enhanced to allow a value to be specified in milliseconds. However, CICS checks for delay expiry every 250 milliseconds, so the actual interval might vary depending on where in the scan cycle your request is made.
Start of changeMILLISECS(data-value)End of change
Start of changespecifies a fullword binary value in the range 0–999, when HOURS, MINUTES or SECONDS are also specified, or 0-359999999 when MILLISECS is the only option specified.End of change

For more information see DELAY.

FORMATTIME

The new option STRINGZONE on the FORMATTIME command specifies in what timezone the DATESTRING value should be returned, UTC or local time.
Start of changeSTRINGZONE(cvda)End of change
Start of changeSpecifies the timezone in which the time stamp returned in DATESTRING is to be returned. The CVDA values are as follows:
UTC
DATESTRING is to be returned in UTC. This value is the default setting.
LOCAL
DATESTRING is to be returned in LOCAL timezone.
End of change

For more information see FORMATTIME.

LINK

Start of changeThis command operates in the current application context. If the command is issued by a program that is running under a task for an application deployed on a platform, CICS® searches first for the named program in the private program directory for the application. If the named program is not found there, CICS then searches the public program directory.End of change

Start of changeWhen this command is used to link to a program that is declared as an application entry point for an application deployed on a platform, the CICS bundle where the application entry point is declared must have a status of AVAILABLE. The link is made to the highest numbered version of the application that is installed, enabled, and available. To link to a specified version of an application deployed on a platform, use the INVOKE APPLICATION command instead of the LINK command.End of change

For more information see LINK.



dfhe5_api_changed.html | Timestamp icon Last updated: Saturday, 15 June 2019