ICape
Writes a string to the PME's log file.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[DispIdAttribute(2)]
void LogMessage(
string message
)VB
<DispIdAttribute(2)>
Sub LogMessage (
message As String
)Parameters
- message String
- The text to be logged.
Remarks
Write a string to a log.
This method is called when a message needs to be recorded for logging purposes. The implementation is expected to write the string to a log file or other journaling device.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | To be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument. |