prefixformat Parameter

Defines the size and type of prefix data that will be maintained with the current file.

Scope: File

Syntax

query prefixformat 
set prefixformat Format [col] 

Options

Format 
This parameter is a string that describes how the prefix parameter is interpreted. This string must be entirely made up of '9 ' and 'X' characters. The '9' characters represent the positions that will contain the numeric part of the prefix data. The 'X' characters represent the positions that will contain the text part of the prefix data. The size of the prefix data is determined by the size of Format.
col 
The starting column at which the prefix data is displayed on a line. If not specified, the value of col is 1.

Description

The prefixformat parameter defines the size, format, and location of the prefix data that will be maintained with the current file. This parameter must be set before the prefix is set for any line in the current file. After the prefix parameter has been set for a line in the file, the prefixformat parameter becomes a read only parameter and can only be queried. If the prefixformat parameter is never set, then it will have a null string default value. In this case, the only valid value for set prefix is an empty string.

Example

  1. To define the prefix data as an AS/400 sequence number with a 6-digit sequence number followed by a 6-digit date, the following command could be used:
    set prefixformat 999999XXXXXX 
  2. To define the prefix data as a 8-digit MVS sequence number appearing in columns 73 to 80 of a line, enter:
    set prefixformat 99999999 73 

API Return Codes

-1 
Parameter is read-only. After the prefix parameter is set, this parameter can no longer be changed.
-2 
Invalid argument specified.
-3 
The Format string is not valid.
-8 
Insufficient storage to continue.

prefix Parameter
autoprefix Parameter
prefixdefaulttext Parameter