Retrieve Office Programs (QOGRTVOE) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Office Programs (QOGRTVOE) API retrieves the programs that are used for office document requests and document conversion requests. The default value for the programs being retrieved is *IBM, which indicates that OfficeVision® processing should be used for the request or conversion.
Authorities and Locks
To use this program you need *SECADM authority.
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable to receive exit program information. This area must be large enough to accommodate the information specified.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable. The length must be at least 8 bytes. If the variable is not large enough to hold the requested information, the data is truncated.
- Format name
- INPUT; CHAR(8)
The format of the program to be retrieved. The valid format is OGOE0100 (see OGOE0100 Format).
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
OGOE0100 Format
The following list shows the format of the program to be retrieved. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Document handling program name |
| 18 | 12 | CHAR(10) | Document handling program library name |
| 28 | 1C | CHAR(1) | Document handling program supports mail flag |
| 29 | 1D | CHAR(10) | Document conversion program name |
| 39 | 27 | CHAR(10) | Document conversion program library name |
| 49 | 31 | CHAR(1) | Application enabler support active flag |
| 50 | 32 | CHAR(1) | Mail handling support active flag |
| 51 | 33 | CHAR(1) | PCFILE identification active flag |
| 52 | 34 | CHAR(1) | Application enabler support activated flag |
| 53 | 35 | CHAR(1) | Mail handling support activated flag |
| 54 | 36 | CHAR(1) | PCFILE identification activated flag |
| 55 | 37 | CHAR(1) | Application enabler support activating flag |
| 56 | 38 | CHAR(1) | Mail handling support activating flag |
| 57 | 39 | CHAR(1) | PCFILE identification activating flag |
Field Descriptions
Application enabler support active flag. An indication of whether the application enabler is active. The application enabler support is active if there is an application defined and the support has been made active.
| 0 | The application enabler support will not be used with this system. |
| 1 | The application enabler support will be used with this system. |
Application enabler support activated flag. An indication of whether the application enabler has been activated with the QOGCHGOE API.
| 0 | The application enabler has not been activated. |
| 1 | The application enabler has been activated. |
Application enabler support activating flag. An indication of whether the application enabler support can be activated. Application enabler support can become active if at least one application is defined and the support is made active with the QOGCHGOE API.
| 0 | The application enabler would not become active if activated. |
| 1 | The application enabler would become active if activated. |
Bytes available. The total length of all data available.
Bytes returned. The length of the data actually returned.
Document conversion program library name. The name of the library containing the program to be called for document conversions. This field will be blanks if the document conversion exit program name is *IBM.
Document conversion program name. The name of the program to be called for document conversions if an IBM conversion does not exist. If the program is *IBM, the IBM-supplied conversion exit or registered conversions will be called.
Document handling program library name. The name of the library containing the program to be called for document requests. This field will be blanks if the document handling exit program name is *IBM.
Document handling program name. The name of the program to be called for document requests. If the program is *IBM, OfficeVision is called for the document requests.
Document handling program supports mail flag. An indication of whether the document handling program supports mail requests (that is, MAILVIEW, MAILFWD, MAILREPLY, PRINT and PRINTOPTS from the Work with Mail display). If *IBM i s specified as the document handling exit program, the value will be 1.
| 0 | The exit program does not support mail. |
| 1 | The exit program does support mail. |
Mail handling support active flag. An indication of whether the Mail Handling support is active. Mail handling support is active if there is an application defined that handles mail, application enabler support has been activated, and mail support has been activated.
| 0 | The mail handling support is inactive with this application. |
| 1 | The mail handling support is active with this application. |
Mail handling support activated flag. An indication of whether the mail handling support could be activated. It is activated with the QOGCHGOE API.
| 0 | The mail handling support has not been activated. |
| 1 | The mail handling support has been activated. |
Mail handling support activating flag. An indication of whether the mail handling support could be activated. Mail handling support is activated with the QOGCHGOE API.
| 0 | The mail handling support cannot be activated. |
| 1 | The mail handling support can be activated. |
PCFILE identification active flag. An indication of whether the PCFILE identification processing support is active. See Note (2). If PCFILE identification support has indicated that at least one type has been defined and PCFILE identification support is active, then the PCFILE identification processing is active.
| 0 | The PCFILE identification processing support is inactive with this application. |
| 1 | The PCFILE identification processing support is active with this application. |
PCFILE identification activated flag. An indication of whether the PCFILE identification processing support could be activated. PCFILE identification is activated with the Change Office Programs (QOGCHGOE) API.
| 0 | The PCFILE identification support has not been activated. |
| 1 | The PCFILE identification support has been activated. |
PCFILE identification activating flag. An indication of whether the PCFILE identification processing could be activated. PCFILE identification support is activated with the QOGCHGOE API.
| 0 | The PCFILE identification processing support would not become active if activated. |
| 1 | The PCFILE identification processing support would become active if activated. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF90A8 E | *SECADM special authority required to do requested operation. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| OFC8019 E | Required module not on system. |
API introduced: V2R2
[ Back to top | Office APIs | APIs by category ]