bdfp1m27 | Programming Concepts and Reference |
Use this macro to display the logical records (LRECs) from a subfile.
Format
|
Notes:
|
The TPFDF product uses the algorithm argument to determine the subfile (ordinal number) that is to be accessed. Specify the algorithm argument based on the type of algorithm that is defined in the DSECT or DBDEF macro for the file. If the DSECT or DBDEF macro defines the #TPFDB04 or the #TPFDB0D algorithm, do not use this parameter.
If the subfile you are accessing is contained in a detail file or intermediate index file defined with the #TPFDBFF algorithm, the TPFDF product uses the algorithm argument to locate the subfile. See TPFDF Database Administration for more information about how the TPFDF product uses the algorithm argument to locate the subfile.
Specify algarg as one of the following:
If the file is partitioned or interleaved, specify the relative ordinal number within the partition or interleave. If the file is not partitioned or interleaved, specify the file address compute program (FACE) ordinal number.
If you specify this parameter, the maximum interleave number must be defined in the DSECT or DBDEF macro. See TPFDF Database Administration for more information about interleaves.
If you specify this parameter, the number of partitions and the end ordinal must be defined in the DSECT or DBDEF macro. See TPFDF Database Administration for more information about partitions.
If you use these parameters, you must also specify the file organization of the keys. See Specifying File Organization with Keyn Parameters for more information about how to do this. Use one or more of the following subparameters with the KEYn parameter:
... KEY1=(PKY=#RR00K80)
This has the same effect as:
... KEY1=(R=RR00KEY,S=#RR00K80)
... KEY1=(PKY=#GR00K80),KEY2=(R=GR00FLD,S=EBW000)
... KEY1=(PKY=#GR00K80),KEY2=(R=EBX010,S=EBW000,L==H'4')
... KEY1=(PKY=#GR00K80),KEY2=(R=D/2,S=EBW000,L=L'GR00NAM,UP)
You can also specify the absolute value implicitly; for example:
... KEY1=(PKY=#GR00K80),KEY2=(R=D/GR00NAM-GR00REC,S=EBW000,L=L'GR00NAM,UP)
... KEY1=(PKY=#GR00K80),KEY2=(R==H'2',S=EBW000,L==H'4')
... KEY1=(PKY=#GR00K80),KEY2=(R=GR00FLD+2,S=EBW000,L==H'4')
or
... KEY1=(PKY=#GR00K80),KEY2=(R=GR00FLD+L'GR00FLD,S=EBW000,L==H'4')
If you specify the S or PKY subparameter, use one of the following values:
If you specify the M or D subparameter, use one of the following values:
... KEY1=(PKY=#GR00K80),KEY2=(R=GR00FLD,D=EBW000,C=Z)
... KEY1=(PKY=#GR00K80),KEY2=(R=GR00FLD,M=X'80',C=Z)
If you specify P/searcharg or a literal in the form of =P'...', the LREC field and search argument are compared as decimal numbers in packed format. Otherwise, the LREC field and search argument are compared as character data.
The default value is the length of the field specified with the R subparameter.
If you do not specify this parameter, the default value for these bytes is X'10F2C20080'. If you specify the LONGTERM parameter, the default value is X'05F2C20090'.
If you specify a value with the OPMT parameter and do not specify NOUIO, control is returned to the application program only if an error occurs.
See TPFDF Database Administration for more information about path numbers.
W-type files are automatically released unless they have been sorted, merged, or checkpointed. In these cases, you must specify the RELFC parameter to release W-type files.
Variable length LRECs contain a 2-byte size field at the front of the user data section. The DBDSP macro automatically discards this field; do not include it in the number of bytes you specify with the STRIP parameter.
Do not use registers R14 or R15 with the STRIP parameter.
Entry Requirements
None.
Normal Return
SW00RTN is set to zero.
Error Return
See Identifying Return Indicators and Errors for information about how to check the error indicators.
Programming Considerations
If you need this type of key definition, you must use a key list.
Examples
In the following example, the amount of data to be stripped is equal to the length of the field GR25KEY:
DBDSP REF=GR25DF,STRIP==AL2(L'GR25KEY)
Related Macros