Put Dialog Variable (QUIPUTV) API
Required Parameter Group:
| 1 | Application handle | Input | Char(8) |
| 2 | Variable buffer | Input | Char(*) |
| 3 | Variable buffer length | Input | Binary(4) |
| 4 | Variable record name | Input | Char(10) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Put Dialog Variable (QUIPUTV) API updates the value of one or more dialog variables by specifying variable buffer of the application program and naming the variable record defined in the panel group for the open application.
Authorities and Locks
None.
Required Parameter Group
- Application handle
- INPUT; CHAR(8)
The application handle assigned by the UIM and returned to the application program by the Open Display Application (QUIOPNDA) API or the Open Print Application (QUIOPNPA) API when the application is opened.
- Variable buffer
- INPUT; CHAR(*)
The program buffer from which dialog variable values are copied. The dialog variables are copied in the order specified in the variable record, which is named in the variable record name parameter.
- Variable buffer length
- INPUT; BINARY(4)
The length of the variable buffer. The buffer must be large enough to contain all the dialog variables in the definition of the variable record, which is specified in the variable record name parameter.
- Variable record name ..
- INPUT; CHAR(10)
The name of the variable record that determines which dialog variables are copied from the variable buffer into the application variable pool. The variable record must be defined in the panel group for the open application.
- 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. |
| CPF6A0F E | Previous error occurred while running application &3. |
| CPF6A24 E | Parameter &1 not passed correctly. |
| CPF6A25 E | Return code length of &1 not valid. |
| CPF6A36 E | Data not correct for dialog variable &4 in panel group &1 in &2. |
| CPF6A37 E | Data not correct for dialog variable &4 in panel group &1 in &2. |
| CPF6A38 E | Variable record &4 not defined in panel group. |
| CPF6A39 E | Variable buffer length too small. |
| 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 ]