Skip to content

Input Message File

Jump to bottom
Mike Greene edited this page Sep 12, 2023 · 1 revision

Input Message File The input message file is a standard ASCII file that contains three types of lines:

  • Comment lines
  • Component identifier line
  • Component message lines

Comment lines are allowed anywhere in the input message file, except between the component identifier and the first message. Comment lines must begin with a semicolon (;) in the first column.

In the Input Message File Example, the comment lines are

; This is a sample of an input; message file for component DOS ; starting with three comment lines. Component Identifier Line

The component-identifier line contains a three-character name identifier that precedes all MKMSGF message numbers.

In the example, the component identifier is DOS.

What is root component ID --- SYS

Component-Message Lines

Each component-message line consists of a message header and an ASCII text message.

<Comp_ID><Msg_Num><Msg_Type><Colon_Space><Message>
[ XXX0000T: Message .... ]

The message header is comprised of the following parts:

Comp_ID - A three-character component identifier
Msg_Num - A four-digit message number
Msg_Type - A single character specifying message type (E, H, I, P, W, ?)

  • E : Error
  • H : Help
  • I : Information
  • P : Prompt
  • W : Warning
  • ? : no message assigned to this number Colon_Space - A colon (:), followed by a blank space.

The message header must begin in the first column of the line. Only one header can precede the text of a message, although a message can span multiple lines.

Message numbers can start at any number, but messages must be numbered sequentially. If you do not use a message number, you must insert an empty entry in its place in the text file. An empty entry consists of the message number, with ? as the message type, and no text.

  • The character % has a special meaning when used within the text of a message:
    - %0 is placed at the end of a prompt (type P) to prevent DosGetMessage from executing a carriage return and line feed. This allows the user to be prompted for input on the same line as the message text.
  • %1 - %9 are used to identify variable string insertion within the text of a message. These variables correspond to the Itable and IvCount parameters in the DosGetMessage call.

Mike Note: The %0 can be used with any message type!!!! So here is how this works: The message file is scanned and each is saved. However, if you place a %0 as the last character the <CR> is dropped and it does not matter the type (E, H, I, P, W, or ?).

Component-Message Example

For example, DOS0100E: is DOS error message 100. For additional examples, see the Input Message File Example.

Return to Home

Clone this wiki locally