LogMessage Method
- Last UpdatedAug 21, 2026
- 1 minute read
Use the LogMessage() method to log client messages to the ArchestrA Logger.
'Declaration
Public Function LogMessage( _
ByVal severity As HistorianMessageSeverity, _
ByVal message As String, _
ByRef error As HistorianAccessError _
) As Boolean
'Usage
Dim instance As HistorianAccess
Dim severity As HistorianMessageSeverity
Dim message As String
Dim error As HistorianAccessError
Dim value As Boolean
value = instance.LogMessage(severity, message, error)
public bool LogMessage(
HistorianMessageSeverity severity,
string message,
out HistorianAccessError error
)
public:
bool LogMessage(
HistorianMessageSeverity severity,
String^ message,
[Out] HistorianAccessError^ error
)
Parameters
- severity
- The HistorianMessageSeverity enumeration, which specifies the message severity, such as Info, Warning, Debug, and Error.
- message
- The message to be logged.
- error
- The object of HistorianAccessError, which contains any error information.
Return Value
Returns True if successful; otherwise, returns False.