| IBasicMessageReporterReportMessage Method |
Used by any component to report a non-critical issue, not explicitly associated
with a content location.
Namespace: Sdl.FileTypeSupport.Framework.NativeApiAssembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
Syntaxvoid ReportMessage(
Object source,
string origin,
ErrorLevel level,
string message,
string locationDescription
)
Sub ReportMessage (
source As Object,
origin As String,
level As ErrorLevel,
message As String,
locationDescription As String
)
void ReportMessage(
Object^ source,
String^ origin,
ErrorLevel level,
String^ message,
String^ locationDescription
)
abstract ReportMessage :
source : Object *
origin : string *
level : ErrorLevel *
message : string *
locationDescription : string -> unit
Parameters
- source
- Type: SystemObject
The component from which the message originates. Components typically pass this for this parameter. - origin
- Type: SystemString
The description of the action/component from which this message originates. - level
- Type: Sdl.FileTypeSupport.Framework.NativeApiErrorLevel
Severity of the message - message
- Type: SystemString
The actual message text - locationDescription
- Type: SystemString
Optional (may be null or String.Empty).
Clear text description of the location that the message refers to. Can be used to communicate
in clear text how the user can find the corresponding location in the content being processed.
Remarks
This overload is used when the message cannot be associated with an explicit content location,
e.g. for issues concerning the whole file/document, or for situations in which an explicit location
is difficult to specify.
See Also
Comments