Macro type: type S (E form/L form/D form/C form); see "Macro types"
The SHOWAIX macro returns, in its operand list, information on the secondary keys of an NK-ISAM file. For each secondary key defined in the file, it shows the user
the name of the key
the position of the key within the record
the length of the key
the DUPEKY setting for the key (whether or not duplicate secondary key values are permitted)
the completeness of the secondary index blocks belonging to the key.
Format
Operation | Operands |
|
|
| |
| |
|
Operand descriptions
FILE = pathname
This specifies the NK-ISAM file for which the secondary key information is to be output with: <c-string 1..54: filename 1..54>..
The value specified for the FILE operand is ignored if the LINK operand is also specified.
“pathname” means [:catid:][$userid.]filename
catid
Catalog ID: if omitted, the default catalog ID for the current user ID is assumed.
userid
User ID: if omitted, the user ID in the SET-LOGON-PARAMETERS or LOGON command is assumed.
filename
Fully qualified file name.
LINK = linkname <1..8>
This specifies the link name of the file for which the secondary key information is to be output.
“linkname” may be up to 8 characters long. If the file link name is to be accessed via the command interface, it must correspond to the data type. <structured_name 1..8> (see the “Commands” manual [3]).
MACID
Specifies the second to fourth characters of each field name and equate generated when the macro is expanded.
Default value: | MACID = ISI |
= macid
“macid” is a three-character string which specifies the second to fourth characters of each field name and equate generated.
PARAM
Specifies the address of the operand list; it is evaluated only if MF=E applies (see "Macro types").
= addr
Symbolic address (name) of the operand list.
= (r)
Number of the register which contains the address of the operand list. The register must be loaded with this address value before the macro is called.
PREFIX
Specifies the first character of each field name or equate which the assembler generates in the data area when expanding the macro.
Default value: | PREFIX=D |
= pre
Single-character prefix with which the generated field names and equates are to begin.
Return codes
Standard header: ccbbaaaa
The following code relating to execution of the SHOWAIX macro is returned in the standard header(cc = SUBCODE2, bb = SUBCODE1, aaaa = MAINCODE):
X'bb' | X'aaaa' | Meaning |
X'00' | X'0000' | The function was executed successfully. |
X'01' | X'0001' | The operand list is not available. |
X'40' | X'0002' | Secondary keys are not supported in the remote system (if the macro is called via RFA). |
X'40' | X'0003' | The specified catalog ID does not exist. |
X'40' | X'0004' | The catalog cannot be accessed. |
X'01' | X'0005' | The operand list contains an invalid name. |
X'20' | X'000B' | System error. |
X'40' | X'000E' | The control block of the file is errored. |
X'01' | X'0017' | There was no file specified in the operand list. |
X'40' | X'0019' | The file link name is invalid. |
X'40' | X'0040' | OPEN error. |
X'40' | X'0041' | CLOSE error. |
X'40' | X'0044' | The file is not an NK-ISAM file. |
Further return codes, whose meanings are defined by conventions valid for all macros, can be found in the table on "Standard header" (standard header).
The calling program is terminated if one of the following errors occurs with regard to the parameter list:
the list is not assigned to the caller
the list is not aligned on a word boundary
the list is write-protected.
Layout of the operand list
Macro expansion with MF=D and default values for PREFIX and MACID:
SHOWAIX MF=D
1 MFCHK MF=D, C
1 PREFIX=D, C
1 MACID=ISI, C
1 DMACID=ISI, C
1 DNAME=ISIAIX, C
1 SUPPORT=(C,D,L,E), C
1 PARAM=, C
1 ALIGN=F, C
1 SVC=32
2 DISIAIX DSECT ,
2 *,##### PREFIX=D, MACID=ISI #####
1 #INTF INTNAME=SHOWAIX,REFTYPE=REQUEST,INTCOMP=001
1 FHDR MF=(C,DISI),EQUATES=NO
2 DS 0A
2 DISIFHE DS 0XL8 0 GENERAL PARAMETER AREA HEADER
2 *
2 DISIIFID DS 0A 0 INTERFACE IDENTIFIER
2 DISIFCTU DS AL2 0 FUNCTION UNIT NUMBER
2 * BIT 15 HEADER FLAG BIT,
2 * MUST BE RESET UNTIL FURTHER NOTICE
2 * BIT 14-12 UNUSED, MUST BE RESET
2 * BIT 11-0 REAL FUNCTION UNIT NUMBER
2 DISIFCT DS AL1 2 FUNCTION NUMBER
2 DISIFCTV DS AL1 3 FUNCTION INTERFACE VERSION NUMBER
2 *
2 DISIRET DS 0A 4 GENERAL RETURN CODE
2 DISISRET DS 0AL2 4 SUB RETURN CODE
2 DISISR2 DS AL1 4 SUB RETURN CODE 2
2 DISISR1 DS AL1 5 SUB RETURN CODE 1
2 DISIMRET DS 0AL2 6 MAIN RETURN CODE
2 DISIMR2 DS AL1 6 MAIN RETURN CODE 2
2 DISIMR1 DS AL1 7 MAIN RETURN CODE 1
2 DISIFHL EQU 8 8 GENERAL OPERAND LIST HEADER LENGTH
2 *
1 *
1 * SUB RETURN CODE1
1 *
1 DISIRFSP EQU X'00' FUNCTION SUCCESSFULLY PROCESSED
1 DISIRPER EQU X'01' PARAMETER SYNTAX ERROR
1 *
1 DISIRFNS EQU X'01' CALLED FUNCTION NOT SUPPORTED
1 DISIRFNA EQU X'02' CALLED FUNCTION NOT AVAILABLE
1 DISIRVNA EQU X'03' INTERFACE VERSION NOT SUPPORTED
1 *
1 DISIRIER EQU X'20' INTERNAL ERROR
1 DISIRCAR EQU X'40' CORRECT AND RETRY
1 *
1 * MAIN RETURN CODE
1 *
1 DISIOK EQU 0 AIX DELETED
1 DISINPAR EQU 1 PARLIST NOT ACCESSIBLE
1 DISINREM EQU 2 NO SUPPORT ON REMOTE HOST
1 DISINCAT EQU 3 CATID NOT KNOWN
1 DISINACC EQU 4 CATALOG NOT ACCESSIBLE
1 DISIINVN EQU 5 INVALID NAME
1 DISISYSE EQU 11 SYSTEM ERROR
1 DISISPAC EQU 12 NO ADDRESS SPACE
1 DISIWRCB EQU 14 WRONG CONTROLBLOCK
1 DISIFNSP EQU 23 FILE NOT SPECIFIED
1 DISILNKE EQU 25 LINKNAME ERROR
1 DISIINOP EQU 31 SSTA INOP
1 DISISSER EQU 32 SSTA INTERNAL ERROR
1 DISIMEMR EQU 33 SSTA MEMORY ERROR
1 DISIOPSE EQU 34 SSTA OPS ERROR
1 DISIOPME EQU 35 SSTA OPS MEMORY ERROR
1 DISIOPER EQU 64 FILE OPEN ERROR
1 DISICLER EQU 65 FILE CLOSE ERROR
1 DISINNKF EQU 68 NO NK-ISAM FILE
1 DISIRLNK EQU X'FFFF' LINKAGE ERROR
1 *
1 DISIDMSC DS AL2 DMSCODE
1 DISIFILE DS CL54 FILE
1 DISILINK DS CL8 LINK
1 DISIKEY# DS H NUMBER OF KEYS
1 *
1 DISIKNAM DS CL8 KEYNAME
1 DISIKPOS DS H KEYPOS
1 DISIKLEN DS AL1 KEYLEN
1 DISIIND DS XL1 INDICATOR
1 DISIDUPK EQU X'80' SET: DUPKEY = YES
1 * RESET: DUPKEY = NO
1 DISIINCO EQU X'40' SET: SIX IS INCOMPLETE
1 * RESET: SIX IS COMPLETE
1 DS 29CL12
1 DISI# EQU (*-DISIFHE) LENGTH OF STRUCTURE
END