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