MessageFileReader class | QSYS API Reference Guide

Estimated reading time: 4 minutes

Provides the contents of a message file.

Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll

Inheritance: Object

Constructors

Name	Description
MessageFileReader(String)	Initializes a new instance of ASNA.QSys.Runtime.MessageFileReaderclass.

MessageFileReader(String)

Initializes a new instance of ASNA.QSys.Runtime.MessageFileReaderclass.

MessageFileReader(String)

Parameters

Type	Parameter name	Description
String	fileName	The name of the compiled message file.

Methods

Signature	Description
GetMessageText(String, Int32)	Gets the message text from the specified prefix and id number.
GetMessageText(String, Int32, Object[])	Gets the message text from the specified prefix and id number, and assigns the replacement text for the symbolic placeholders put in the message file.
GetSecondMessageText(String, Int32)	Gets the second level message text from the specified prefix and id number.
GetSecondMessageText(String, Int32, Object[])	Gets the second level message text from the specified prefix and id number,and assigns the replacement text for the symbolic placeholders put in the second level text of the message file.
InsertReplacementValues(String, Object[])	Creates a formatted string given an IBM-style message with replacement characters and corresponding replacement values.

string GetMessageText(string prefix, int id)

Gets the message text from the specified prefix and id number.

string GetMessageText(string prefix, int id)

Parameters

Type	Parameter name	Description
String	prefix	The 3 character string prefix under which the requested message is stored.
Int32	id	The numeric value under which the requested message is stored.

Returns

Type	Description
String

string GetMessageText(string prefix, int id, Object[] replacementValues)

Gets the message text from the specified prefix and id number, and assigns the replacement text for the symbolic placeholders put in the message file.

string GetMessageText(string prefix, int id, Object[] replacementValues)

Parameters

Type	Parameter name	Description
String	prefix	The 3 character string prefix under which the requested message is stored.
Int32	id	The numeric value under which the requested message is stored.
Object[]	replacementValues	An array of objects meant to replace the symbolic placeholders placed in the message file.

Returns

Type	Description
String

string GetSecondMessageText(string prefix, int id)

Gets the second level message text from the specified prefix and id number.

string GetSecondMessageText(string prefix, int id)

Parameters

Type	Parameter name	Description
String	prefix	The 3 character string prefix under which the requested message is stored.
Int32	id	The numeric value under which the requested message is stored.

Returns

Type	Description
String

string GetSecondMessageText(string prefix, int id, Object[] replacementValues)

Gets the second level message text from the specified prefix and id number,and assigns the replacement text for the symbolic placeholders put in the second level text of the message file.

string GetSecondMessageText(string prefix, int id, Object[] replacementValues)

Parameters

Type	Parameter name	Description
String	prefix	The 3 character string prefix under which the requested message is stored.
Int32	id	The numeric value under which the requested message is stored.
Object[]	replacementValues	An array of objects meant to replace the symbolic placeholders placed in the second level text of the message file.

Returns

Type	Description
String

string InsertReplacementValues(string text, Object[] replacementValues)

Creates a formatted string given an IBM-style message with replacement characters and corresponding replacement values.

string InsertReplacementValues(string text, Object[] replacementValues)

Parameters

Type	Parameter name	Description
String	text	The IBM-style message string.
Object[]	replacementValues	An array of replacements to insert in the message string.

Returns

Type	Description
String	The formatted string.