GET USER PROPERTIES

Home

4D v16.3

GET USER PROPERTIES


GET USER PROPERTIES ( userID ; name ; startup ; password ; nbLogin ; lastLogin {; memberships {; groupOwner}} )

Parameter	Type	Description
userID	Longint	Unique user ID number
name	String	Name of the user
startup	String	Startup method name
password	String	Always an empty string
nbLogin	Longint	Number of logins to the database
lastLogin	Date	Date of last login to the database
memberships	Longint array	ID numbers of groups to which the user belongs
groupOwner	Longint	ID number of user group owner

Description

GET USER PROPERTIES returns the information about the user whose unique user ID number you pass in userID. You must pass a valid user ID number returned by the GET USER LIST command.

If the user account does not exist or has been deleted, the error -9979 is generated. You can catch this error with an error-handling method installed using ON ERR CALL. Otherwise, you can call Is user deleted to test the user account before calling GET USER PROPERTIES.

User ID numbers can have the following values or ranges:

User ID number	User description
1	Designer user
2	Administrator user
3 to 15000	User created by the Designer of the database
	(user #3 is the first user created by the Designer, user #4 the second, and so on).
-11 to -15000	User created by the Administrator of the database
	(user #-11 is the first user created by the Designer, user #-12 is the second, and so on).

After the call, you retrieve the name, startup method, encrypted password, number of logins and date of last login for the user, in the parameters name, startup, password, nbLogin and lastLogin.

Note: The password parameter is obsolete (it always returns an empty string). If you want to check a user's password, use the Validate password function.

If you pass the optional memberships parameter, the unique ID numbers of the groups to which the user belongs are returned. Group ID numbers can have the following ranges:

If you pass the optional groupOwner parameter, you get the ID number of the user group “owner”, i.e. the default owner group of the objects created by this user.

The group ID numbers can be the following:

Group ID number	Group description
15001 to 32767	Group created by the Designer or affiliated Group Owner
	(group #15001 is the first group created by the Designer, group #15002 the second, and so on).
-15001 to -32768	Group created by the Administrator or affiliated Group Owner
	(group #-15001 is the first group created by the Administrator, group #-15002 the second, and so on).

Error management

If you do not have the proper access privileges for calling GET USER PROPERTIES or if the Password system is already accessed by another process, an access privilege error is generated. You can catch this error with an error-handling method installed using ON ERR CALL.