BuildComponentCore.WriteMessage Method

Definition

Namespace

Sandcastle.Core.BuildAssembler.BuildComponent

Assembly

Sandcastle.Core.dll

WriteMessage(MessageLevel, string, params object[])

This can be used to report a message

public void WriteMessage(MessageLevel level, string message, params object[] args)

Parameters

level MessageLevel

The message level

message string

The message to report

args object[]

An optional list of arguments to format into the message

WriteMessage(string, MessageLevel, string, params object[])

This can be used to report a message for a specific topic ID

public void WriteMessage(string key, MessageLevel level, string message, params object[] args)

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.