PQUERY—obtain panel information

The PQUERY service returns information for a specified area on a specific panel. The type, DYNAMIC or GRAPHIC, size, and position characteristics associated with the area are returned in variables.

Command invocation format


>>-ISPEXEC--PQUERY--PANEL(panel-name)--AREANAME(area-name)------>

>--+--------------------------+--+------------------------+----->
   '-AREATYPE(area-type-name)-'  '-WIDTH(area-width-name)-'   

>--+------------------------+--+----------------------+--------->
   '-DEPTH(area-depth-name)-'  '-ROW(row-number-name)-'   

>--+----------------------------+------------------------------><
   '-COLUMN(column-number-name)-'

Call invocation format


>>-CALL--ISPEXEC--(buf-len,--buffer);--------------------------><


>>-CALL--ISPLINK--('PQUERYbb'--,--panel-name,--area-name-------->

>--,-+-area-type-name-+--,-+-area-width-name-+------------------>
     '-'b'------------'    '-'b'-------------'   

>--,-+-area-depth-name-+--,-+-row-number-name-+----------------->
     '-'b'-------------'    '-'b'-------------'   

>--,-+-column-number-name-+-);---------------------------------><
     '-'b'----------------'

Parameters

panel-name: Specifies the name of the panel for which information is desired.
area-name: Specifies the name of an area within the panel whose attributes are to be returned.
area-type-name: Specifies the name of a variable in which the area type is to be stored. Either DYNAMIC or GRAPHIC is returned left-justified and padded with blanks. Nulls are returned if the return code is nonzero.
area-width-name: Specifies the name of a variable in which the number of columns in the area is to be stored. For a call, the variable should be defined as a fullword fixed integer.
area-depth-name: Specifies the name of a variable in which the number of rows comprising the area is to be stored. For areas that are not extendable (EXTEND(OFF)), this is the number of rows of the rectangular area in the panel definition. For extendable areas (EXTEND(ON)), this is the number of rows in the area after the panel body has been automatically extended to the depth of the physical screen on which the PQUERY service request is being issued. When issuing a PQUERY service request in the batch environment, the screen depth is specified as the value of the BATSCRD parameter on the ISPSTART call. For a call, the variable should be defined as a fullword fixed integer.
row-number-name: Specifies the name of a variable in which the number of the row of the top left position of the area is to be stored. For a call, the variable should be defined as a fullword fixed integer.
column-number-name: Specifies the name of a variable in which the number of the column of the top left position of the area is to be stored. For a call, the variable should be defined as a fullword fixed integer.
buf-len: Specifies a fullword fixed binary integer containing the length of "buffer".
buffer: Specifies a buffer containing the name of the service and its parameters in the same form as they would appear in an ISPEXEC call for a command procedure.

If the panel uses a variable for the WIDTH keyword value on the BODY header, such as )BODY WIDTH(&WID), that variable must be set before invoking the PQUERY service.

Return codes

These return codes are possible:

0: Normal completion
8: The panel does not contain the specified area.
12: The specified panel cannot be found.
16: Not all are values returned because insufficient space was provided.
20: Severe error.

Example

For the area named AREA1 on panel XYZ, return the number of columns in variable PQCOLS and the area type in variable ATYPE.

ISPEXEC PQUERY PANEL(XYZ) AREANAME(AREA1)
AREATYPE(ATYPE) WIDTH(PQCOLS)

Set the program variable BUFFER to contain:

PQUERY PANEL(XYZ) AREANAME(AREA1) AREATYPE(ATYPE) WIDTH(PQCOLS)

Set program variable BUFLEN to the length of the variable BUFFER. Issue the command:

CALL ISPEXEC (BUFLEN, BUFFER);

or alternately

CALL ISPLINK ('PQUERY  ','XYZ ','AREA1 ',
              'ATYPE ','PQCOLS ');