Close Application (QUICLOA) API


  Required Parameter Group:

1 Application handle Input Char(8)
2 Close option Input Char(1)
3 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Close Application (QUICLOA) API closes a UIM application that was opened using the Open Display Application (QUIOPNDA) API or the Open Print Application (QUIOPNPA) API. The open and close APIs must be used in pairs to open and close each UIM application.

The QUICLOA API releases all UIM resources associated with the open application, destroying the variable pool and deleting any associated active lists. The storage for internal control blocks supporting the application is freed, and all locks acquired for the open application are released.


Authorities and Locks

None.


Required Parameter Group

Application handle
INPUT; CHAR(8)

The open application for which this API is called. The application handle is assigned by the UIM and returned to the application program when the application is opened.

Close option
INPUT; CHAR(1)

Indicates whether to perform a normal or abnormal close operation. One of the following values must be specified:

A An abnormal close operation is performed. This operation is used when the application prematurely ends processing in the most efficient manner possible. When an application with an open printer file is closed with the abnormal option, the printer trailer text specified on the print trailer message (PRTTRAIL) tag is not printed.
M A normal close operation is performed.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Error Messages

Message ID Error Message Text
CPF3C90 E Literal value cannot be changed.
CPF6A0B E Application handle &3 not valid.
CPF6A0C E Application domain error for application &1.
CPF6A11 E Value is not correct. Reason code is &3.
CPF6A24 E Parameter &1 not passed correctly.
CPF6A25 E Return code length of &1 not valid.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V2R2

[ Back to top | User Interface Manager APIs | APIs by category ]