MpUserLogin

mapp Services V5.16

This function block allows users to log in and out (via the application) and is necessary for all user management.

Function block

Optional parameters

mpuserlogin

mpuserlogin_opt

Interface

I/O	Parameter	Data type	Description
IN	MpLink	Pointer to MpComIdentType	Connection to mapp configuration (MpLink of an MpUserLogin configuration).
IN	Enable	BOOL	The function block is active as long as this input is set.
IN	ErrorReset	BOOL	Resets function block errors.
IN	LifeSign	DINT	Used to determine if the logged in user has been inactive for a long time. The inactivity time is reset when this input changes.
IN	Login	BOOL	Command used to log in.
IN	Logout	BOOL	Command used to log out.
IN	UserName	Pointer to WSTRING[20]	Username to be used for logging in.
IN	Password	Pointer to WSTRING[20]	Password to be used for logging in.
OUT	Active	BOOL	Function block active.
OUT	Error	BOOL	Indicates that the function block is in an error state or a command was not executed correctly.
OUT	StatusID	DINT	Status information.
OUT	CommandBusy	BOOL	Function block currently executing command.
OUT	CommandDone	BOOL	Execution successful. Function block is finished.
OUT	CurrentUser	WSTRING[40]	Username of the logged in user.
OUT	CurrentLevel	DINT	Level of the logged in user.
OUT	AccessRights	ARRAY[0..19] of MpUserAccessRightEnum	Access rights of the logged in user.
OUT	Info	MpUserLoginInfoType	Additional function block information.

mapp concept

Section mapp components explains how mapp components are structured. In addition, it provides important notes for correctly using mapp components (e.g. for downloads).

Topics in this section:

•Description