Sandcastle Help File Builder Documentation
Build
This can be used to report a message for a specific topic ID
Definition
Namespace: Sandcastle.Core.BuildAssembler.BuildComponent
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.9.12.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.9.12.0
C#
public void WriteMessage(
string key,
MessageLevel level,
string message,
params Object[] args
)VB
Public Sub WriteMessage (
key As String,
level As MessageLevel,
message As String,
ParamArray args As Object()
)C++
public:
void WriteMessage(
String^ key,
MessageLevel level,
String^ message,
... array<Object^>^ args
)F#
member WriteMessage :
key : string *
level : MessageLevel *
message : string *
args : Object[] -> unit Parameters
- key String
- The topic key related to the message
- level MessageLevel
- The message level
- message String
- The message to report
- args Object
- An optional list of arguments to format into the message
Remarks
This is useful for warning and error messages as the topic ID will be included even when
the message level is set to warnings or higher. In such cases, the informational messages containing
the "building topic X" messages are suppressed.