Change Office Program (QOGCHGOE) API
Required Parameter Group:
| 1 | Qualified document handling exit program | Input | Char(20) |
| 2 | Document handling program supports mail flag | Input | Char(1) |
| 3 | Qualified document conversion exit program | Input | Char(20) |
| 4 | Error code | I/O | Char(*) |
Optional Parameter Group:
| 5 | Activate application enabler support | Input | Char(1) |
| 6 | Activate mail handling support | Input | Char(1) |
| 7 | Activate PCFILE identification processing support | Input | Char(1) |
Default Public Authority: *USE
Threadsafe: No
The Change Office Program (QOGCHGOE) API allows you to set or change the document handling and document conversion exit programs. The default value for these exit programs is *IBM, which indicates that OfficeVision® processing should be used for the request or conversion.
Authorites and Locks
You must have security administrator (*SECADM) authority to call this program.
Required Parameter Group
- Qualified document handling exit program
- INPUT; CHAR(20)
The name of the program called when document editing and print requests are made. The first 10 characters contain the program name, and the second 10 characters contain the name of the library where the program is located.
*IBM OfficeVision should process document requests. The library name should be blanks if *IBM i s specified in the program name.
- Document handling program supports mail flag
- INPUT; CHAR(1)
This flag indicates whether the document handling program supports mail requests (that is, MAILVIEW, MAILEDIT, EDIT using Revise a Copy, MAILFWD, MAILREPLY, PRINT and PRINTOPTS from the Work with Mail display). If an application does not plan to handle these functions, set the value to 0. Setting the value to 0 prevents the unnecessary overhead of filing the mail items and calling the document handling program. If the document handling program is *IBM, set the value to 1.
0 Mail requests are not supported. 1 Mail requests are supported.
This indicates whether the program specified in the document handling exit program and library name parameter should be called for mail requests.
- Qualified document conversion exit program
- INPUT; CHAR(20)
The name of the program that is used to do document conversions when office services requires the document to be in a different data stream format. The first 10 characters contain the program name, and the second 10 characters contain the name of the library where the program is located.
*IBM Use the IBM-supplied document conversion exit program. The library name should be blank if *IBM i s specified in the program name.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Optional Parameter Group
- Activate application enabler support
- INPUT; CHAR(1)
If an application does not plan to handle these functions, set the value to 0. If the application requires application enabler support, set the value to 1. Any other value does not change the current activation of application enabler support.
0 Application enabler support is inactive. 1 Application enabler support is active.
- Activate mail handling support
- INPUT; CHAR(1)
If an application does not plan to handle these functions, set the value to 0. If the program requires mail handling support, set the value to 1. Any other value does not change the current activation of mail handling support.
0 Mail handling support is inactive. 1 Mail handling support is active.
- Activate PCFILE identification processing support
- INPUT; CHAR(1)
If an application does not plan to handle these functions, set the value to 0. If the program requires PCFILE identification processing support, (1) set the value to 1. Any other value does not change the current activation of PCFILE identification processing support.
0 PCFILE identification processing support is inactive. 1 PCFILE identification processing support is active.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C90 E | Literal value cannot be changed. |
| CPF3C29 E | Object name &1 is not valid. |
| CPF90A8 E | *SECADM special authority required to do requested operation. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| OFC15FF E | Value &1 for mail handled parameter is not valid. |
| OFC8019 E | Required module not on system. |
API introduced: V2R2
[ Back to top | Office APIs | APIs by category ]