IMessaging Interface
Interface for handling messages (error/warning/verbose).
Methods
| Method | Description |
|---|---|
| ElevateWarningMessage(warningNumber) | Adds a warning message id to be elevated to an error message. |
| SetListener(listener) | Sets the listener for messaging. |
| SuppressWarningMessage(warningNumber) | Adds a warning message id to be suppressed in message output. |
| Write(message) | Sends a message with the given arguments. |
| Write(message, verbose) | Sends a message with the given arguments. |
Properties
| Property | Description |
|---|---|
| EncounteredError | Indicates whether an error has been found. |
| ErrorCount | Gets the number of errors encountered thus far. |
| LastErrorNumber | Gets the last error code encountered during messaging. |
| ShowVerboseMessages | Gets or sets the option to show verbose messages. |
| SuppressAllWarnings | Gets or sets the option to suppress all warning messages. |
| WarningsAsError | Gets and sets the option to treat warnings as errors. |
WixToolset.Extensibility.dll version 5.0.2+aa65968c419420d32e3e1b647aea0082f5ca5b78
ElevateWarningMessage(warningNumber) Method
Adds a warning message id to be elevated to an error message.
Declaration
public void ElevateWarningMessage(
int warningNumber
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| warningNumber | int | Id of the message to elevate. |
SetListener(listener) Method
Sets the listener for messaging.
Declaration
public void SetListener(
WixToolset.Extensibility.IMessageListener listener
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| listener | WixToolset.Extensibility.IMessageListener |
SuppressWarningMessage(warningNumber) Method
Adds a warning message id to be suppressed in message output.
Declaration
public void SuppressWarningMessage(
int warningNumber
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| warningNumber | int | Id of the message to suppress. |
Write(message) Method
Sends a message with the given arguments.
Declaration
public void Write(
WixToolset.Data.Message message
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| message | WixToolset.Data.Message | Message to write. |
Write(message, verbose) Method
Sends a message with the given arguments.
Declaration
public void Write(
string message,
bool verbose
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| message | string | Message to write. |
| verbose | bool | Indicates where to write a verbose message. |
EncounteredError Property
Indicates whether an error has been found.
Declaration
public bool EncounteredError { get; set; }
ErrorCount Property
Gets the number of errors encountered thus far.
Declaration
public int ErrorCount { get; set; }
LastErrorNumber Property
Gets the last error code encountered during messaging.
Declaration
public int LastErrorNumber { get; set; }
ShowVerboseMessages Property
Gets or sets the option to show verbose messages.
Declaration
public bool ShowVerboseMessages { get; set; }
SuppressAllWarnings Property
Gets or sets the option to suppress all warning messages.
Declaration
public bool SuppressAllWarnings { get; set; }
WarningsAsError Property
Gets and sets the option to treat warnings as errors.
Declaration
public bool WarningsAsError { get; set; }