OVRDSPF Command syntax diagram
The Override with Display File (OVRDSPF) command is used to (1) override (replace) the file named in the program, (2) override certain parameters of a file used by the program, or (3) override the file named in the program and override certain parameters of the file processed. Parameters overridden by this command are specified in the file description, in the program, or in other called file override commands.
If a file named in the program is overridden, the name of that file is specified in the FILE parameter and the name of the overriding file (the file being processed) is specified in the TOFILE parameter. The OVRDSPF command also specifies parameters to override values contained in the file description of the overriding file. If the file named in the program is not replaced but certain parameters of the file are overridden, the name of the file is specified in the FILE parameter and *FILE is specified in the TOFILE parameter. The parameters overridden are then specified by the other parameters of the OVRDSPF command. Parameters that are not specified do not affect parameters specified in the file description, in the program, or in other called file override commands.
More information on overriding files is in the File Management topic in the Information Center, and the Application Display Programming book.
*FILE: The display device file named in the FILE parameter has some of its parameters overridden by the values specified in this command.
The name of the file can be qualified by one of the following library values:
*LIBL: All libraries in the job's library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched.
display-device-file-name: Specify the name of the display device file used instead of the overridden file.
This parameter overrides the device names specified in the device file, in the program, or in other called OVRDSPF commands.
*REQUESTER: The device from which the program is called is assigned to the file when the file is opened.
device-name: Specify the names of one or more display devices used with this device file to pass data records between the users of the devices and the system. Each device name must already be known on the system by a device description before this device file is created. *REQUESTER can be specified as one of the names. Up to 50 names can be specified in this command, but the total number cannot exceed the number specified on the MAXDEV parameter.
*DEVD: The CHRID value specified in the device description of the work station on which the application is running is used. If no CHRID value is specified, the QCHRID system value (for the system on which the application is running) is used. No translation is necessary because the file has the same character identifier as the work station. For a list of valid values, see the CHRID parameter of the Create Device Description Display (CRTDEVDSP) command description.
*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system values.
*JOBCCSID: The character data is converted, if necessary, from the device CHRID to the CCSID (coded character set identifier) of the job during input, and from the CCSID of the job to the device CHRID on output.
Note: | This value is not allowed if the file was created on a system at an earlier release level than V2R3M0. |
*CHRIDCTL: The system checks the CHRIDCTL job definition attribute to determine whether to use *JOBCCSID or *DEVD on the CHRID command parameter for this file.
Element 1: Character Set
graphic-character-set: Specify the graphic character set values that match the attributes of the display device. Valid values range from 1 through 32767.
Element 2: Code Page
code-page: Specify the code page set values that match the attributes of the display device. Valid values range from 1 through 32767.
*FILE: Use the decimal format value stored with the file when the file was created.
*JOB: Use the decimal format value from the DECFMT job attribute when the file is opened.
*FILE: Use the 'More...' and 'Bottom' text that is stored in the file during file creation. This text was retrieved from messages CPX6AB1 and CPX6AB2 which exist in the active language of the system when the file was created.
*MSG: Use the 'More...' and 'Bottom' text retrieved from messages CPX6AB1 and CPX6AB2 which exist in the current active language of the system when the file is opened.
*NO: The input buffer will be restored to its original values before it is returned to the application. Any date, time or timestamp field which has invalid data is replaced in the input buffer with a valid default value.
*YES: The input buffer, which may include values that did not pass the validity checks, will be returned to the application. Any date, time, or timestamp field which has invalid data is replaced in the input buffer with a valid default value.
*NO: The file does not process DBCS data.
*YES: The file processes DBCS data.
*YES: The system processes DBCS extension characters.
*NO: The system does not process DBCS extension characters; it displays extension characters as the undefined character.
Note: | An immediate allocation of the device by the device resource is required when an acquire operation is performed to the file. |
This parameter overrides the wait time specified in the device file, in the program, or in other called OVRDSPF commands.
*IMMED: The program does not wait; when the file is opened, an immediate allocation of the file resources is required.
*CLS: The job default wait time is used as the wait time for the file resources being allocated.
number-of-seconds: Specify the number of seconds that the program waits for the file resources to be allocated to the display device file when the file is opened, or the wait time for the device allocated when an acquire operation is performed to the file. Valid values range from 1 through 32767 seconds.
Note: | This parameter is also used to specify the time (seconds) that a CL program waits to complete a WAIT command. If a record is not returned from any of the devices that should return a record, an escape message is sent to the CL program. More information on the WAITRCD parameter is in the Receive File (RCVF), Send File (SNDF), Send/Receive File (SNDRCVF), and WAIT (Wait) command descriptions. |
This parameter overrides the wait record value specified in the device file, in the program, or in other called OVRDSPF commands.
*NOMAX: There is no limit on the time the system waits for the completion of the operation.
*IMMED: The program does not wait for the read-from-invited-device operation for the completion of the file. A record must be available from an invited program device when the read-from-invited-program-device operation is performed. If a record is not already available when the read-from-invited-program-device operation is performed, a notify message is sent to the program.
number-of-seconds: Specify the number of seconds that the program waits for the completion of the read-from-invited-device operation. Valid values range from 1 through 32767.
Note: | This parameter overrides the value specified in the device file, in the program, or in other called OVRDSPF commands. Level checking cannot be done unless the program contains the record format identifiers. This command cannot override level checking from *NO to *YES. |
*NO: The level identifiers are not checked when the file is opened.
*NO: This file is not protected from the effects of other file overrides; its values can be overridden by the effects of previously called file override commands.
*YES: This file is protected from the effects of any file override commands previously called.
*ACTGRPDFN: The scope of the override is determined by the activation group of the program that calls this command. When the activation group is the default activation group, the scope equals the call level of the calling program. When the activation group is not the default activation group, the scope equals the activation group of the calling program.
*CALLLVL: The scope of the override is determined by the current call level. All open operations done at a call level that is the same as or higher than the current call level are influenced by this override.
*JOB: The scope of the override is the job in which the override occurs.
*NONE: A data queue does not receive an entry from the system.
The name of the data queue can be qualified by one of the following library values:
*LIBL: All libraries in the job's library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched.
data-queue-name: Specify the name of the data queue that is to receive an entry from the system when the data-available event is signaled.
More information on shared database files is in the Database Programming topic in the Information Center.
This parameter overrides the value specified in the device file, in the program, or in other called OVRDSPF commands.
*NO: The ODP created by the program with this attribute is not shared with other programs in the routing step. Every time a program opens the file with this attribute, a new ODP to the file is created and activated.
*YES: The ODP created with this attribute is shared with each program in the routing step that also specifies SHARE(*YES) when it opens the file.
Note: | When SHARE(*YES) is specified and control is passed to a program, a read operation in that program retrieves the next input record. A write operation produces the next output record. |
*ACTGRPDFN: The scope of the open operation is determined by the activation group of the program that called the OVRDSPF command processing program. If the activation group is the default activation group, the scope is the call level of the caller. If the activation group is a non-default activation group, the scope is the activation group of the caller.
*JOB: The scope of the open operation is the job in which the open operation occurs.
Example for OVRDSPF
OVRDSPF FILE(DISPLAY75) WAITFILE(30)
This command overrides the file wait time value specified in the DISPLAY75 device file description, in the program, or in other called OVRDSPF commands. The program in which this command occurs waits up to 30 seconds (if necessary) to allocate the required file resources to the file named DISPLAY75.
Error messages for OVRDSPF
*ESCAPE Messages