ForceLogoutEx

function ForceLogoutEx(ctx: Required<TcHmi.Context>, username: string | null | undefined)

The ForceLogoutEx function logs out a specific user or all users on all client instances connected to the server. The function ForceLogoutEx provides a context parameter of type TcHmi.Context, which allows the framework to wait for the asynchronous signaling of the end of the action when executing within triggers or function expressions.

Refer also to the description page for the corresponding API function.

Parameter

Name	Type	Description
ctx	Required<TcHmi.Context>	Context object Does not need to be specified by the user when used in a trigger or function expression. In this case the transfer and the evaluation is done by the corresponding parser. Is used by the caller to indicate success or failure to the framework during execution. If the function is used directly in JavaScript/TypeScript, the context object must be passed in the call and evaluated if necessary.
username [ optional ]	string \| null \| undefined	The user name to be logged out on all client instances connected to the server. If the parameter is not specified, all users are logged out.

Name

Type

Description

ctx

Required<TcHmi.Context>

Context object

Does not need to be specified by the user when used in a trigger or function expression. In this case the transfer and the evaluation is done by the corresponding parser.

Is used by the caller to indicate success or failure to the framework during execution.

If the function is used directly in JavaScript/TypeScript, the context object must be passed in the call and evaluated if necessary.

username [ optional ]

string | null | undefined

The user name to be logged out on all client instances connected to the server.

If the parameter is not specified, all users are logged out.

Return value

Type	Description
void	No return value.

NuGet package: Beckhoff.TwinCAT.HMI.Functions

	NuGet packages are available from version 1.12.

	Available from version 1.12