prefixdisplayformat Parameter

Specifies a format string that is used to display the prefix area.

Scope: View

Syntax

query prefixdisplayformat 
set prefixdisplayformat Format 

Options

Format 
This string describes how the prefix data will be displayed, subject to the following rules:
  • The length of the string is equal to the number of characters that you wish to have displayed.
  • 'X' characters found in the format string will be replaced by the text part of the prefix area.
  • '9' characters found in the format string will be replaced by the numeric part of the prefix area.
  • All other characters in the format string will be displayed without substitution.
  • If you wish to include a '9' or an 'X' as part of the displayed prefix, it must be preceded by a '\' character.
  • If the numeric part of the prefix data overflows its space in the format string, it will be truncated on the left.
  • If the numeric part of the prefix data does not fill its space in the format string, it will be padded with leading zeros.
  • If there are more 'X' characters than text data, the remaining 'X' characters will be padded with blanks.
  • If there is more text data than 'X' characters, the unused characters will not be displayed.

Description

The prefixdisplayformat parameter controls how the prefix data will be displayed in the left margin of an edit view. The prefix data is divided into two parts, a text part and a numeric part. This division is defined by the prefixformat parameter. The format string will determine how these two parts are displayed in relation to one another.

Note that the prefixshow parameter must be used to control whether the prefix data is actually displayed. If there is no prefix data, or there is no numeric part to the prefix data, the line number will be displayed in the numeric part of the prefixdisplayformat format string.

If the text part of the prefix data contains DBCS data, no attempt to maintain the integrity of DBCS characters will be made during display formatting.

Example

If the prefixformat parameter is set to 999999XXXXXX, and the numeric part consists of a 6-digit number and the text part consists of a 6- digit date. To display the prefix data area as a 6-digit sequence number followed by the date, the following command could be used.

set prefixdisplayformat "999999 XX/XX/XX"

API Return Codes

-8 
Insufficient storage to continue.

prefixformat Parameter
prefixshow Parameter