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
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
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
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
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
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
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. |