IVisuUserManagement3.Login (METH)

METHOD Login : VUM_ReturnValues

It executes the login It works with both legacy and runtime-based user management If everything is correct the function returns VUM_ReturnValues.ERR_OK. see VUM_ReturnValues (ENUM) where possible error reasons are described.

InOut:

Scope

Name

Type

Comment

Return

Login

VUM_ReturnValues

Input

pClient

POINTER TO BYTE

A pointer to the visualization client - POINTER TO VisuElems.VisuStructClientData

wstUserName

WSTRING(79)

The user name

wstPassword

WSTRING(79)

The password of the user

Output

wstFullNameIfAvailable

WSTRING

The full name of the user, it it’s available

dwUserGroupID

DWORD

The group id where the user belongs to

adwUserGroupIDs

ARRAY [0..VUM_Constants.VISU_VUM_MAX_GROUPS_PER_USER] OF DWORD

Array of user group ids. In the first entry there’s the user group id, same of dwUserGroupID

dwUserGroupCount

DWORD

Number of additional user groups

bDeactivated

BOOL

Is the user deactivated