FB_CoreStation - AddUserMessageToAPL (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Task

Sending a logger message to the Application Logger with logger level APL.ET_Loglevel.UserAction.

For more information on the logger levels, refer to: ET_LogLevel.

Description

With the method AddUserMessageToAPL, you can send a logger message to the Application Logger.

The method AddUserMessageToAPL can only be called when the function block FB_CoreStation has been registered as a logger point to the Application Logger by using the method RegisterLoggerPoint.

NOTE: The information that is given to the logger point during the call of RegisterLoggerPoint is linked to the messages that are sent via this logger point and does not have to be included inside the messages.

Inputs

Input	Data type	Description
i_sMsg	STRING [255]	The user-defined logger message.

Outputs

Output	Data type	Description
q_xError	BOOL	Indicates TRUE if an error has been detected. For details, refer to q_etResult and q_sResultMsg.
q_etResult	ET_Result	Provides diagnostic and status information as a numeric value. If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.
q_sResultMsg	STRING [255]	Provides additional diagnostic and status information as a text message.

Access Specifiers

The method AddUserMessageToAPL is assigned the access specifiers FINAL and PROTECTED.

The specifier FINAL helps to protect the method from being overwritten. The specifier PROTECTED ensures that the method can only be called and shown inside a function block inheriting the function block FB_CoreStation.

For more information, see Mandatory Access Specifiers.