PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of gpwUser variables
  • Functions that use the gpwUser type:
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
The gpwUser type is used to describe and modify the characteristics of a user of WEBDEV or WINDEV user groupware.
Note: See Declaring a variable for more details.
Versions 22 and later
WINDEVLinux This type of variable is now available for the WINDEV applications in Linux.
WINDEVWindows This type of variable is now available for the WINDEV applications in Windows.
New in version 22
WINDEVLinux This type of variable is now available for the WINDEV applications in Linux.
WINDEVWindows This type of variable is now available for the WINDEV applications in Windows.
WINDEVLinux This type of variable is now available for the WINDEV applications in Linux.
WINDEVWindows This type of variable is now available for the WINDEV applications in Windows.
Example
WEBDEV - Server code
// Values of new user
clUser is gpwUser
clUser..Email = EDT_Email
clUser..Login = EDT_Login
clUser..Password = EDT_Password
clUser..LastName = EDT_LastName
clUser..FirstName = EDT_FirstName
clUser..PhoneNumber = EDT_Phone

// Add the user
IF gpwAddUser(clUser) = False THEN
Info("Unable to add the user.")
RETURN
END

// Activate the user
SWITCH gpwActivateUser(clUser..Login)
// For an activation by email
CASE gpwActivationByEmail
PopupDisplay(POPUP_ValidateSubscription)

// For an immediate activation
CASE gpwActivationImmediate
// Connects the user directly
gpwConnectUser(clUser..Login, clUser..Password)
// Displays the confirmation popup
PopupDisplay(POPUP_ConfirmSubscription)

OTHER CASE
Info("Unable to activate the user.")
END
Remarks

Properties specific to the description of gpwUser variables

The following properties can be used to handle a gpwUser variable:
NameType usedEffect
EnabledBoolean
  • True if the user is enabled,
  • False otherwise.
EmailCharacter stringEmail address of user.
IDExternalCharacter stringIdentifier of the user in a database external to the groupware. This property can be used for example to link the user of the user groupware of the User file of the application that is using the groupware by referencing its identifier.
Caution: this property is available from version 190056.
LoginCharacter stringLogin of user.
PasswordCharacter stringPassword of user.
NameCharacter stringLast name of user.
FirstNameCharacter stringFirst name of user.
SupervisorBoolean
  • True if the user is supervisor,
  • False otherwise.
PhoneNumberCharacter stringPhone number of user.


Note: These properties can be used with one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Functions that use the gpwUser type:

Versions 19 and later
gpwAddUser
New in version 19
gpwAddUser
gpwAddUser
Adds a user into the database of user groupware.
Versions 19 and later
gpwFindUser
New in version 19
gpwFindUser
gpwFindUser
Retrieves the characteristics of a user of the user groupware.
Versions 19 and later
gpwModifyUser
New in version 19
gpwModifyUser
gpwModifyUser
Modifies a user in the database of user groupware.
Minimum required version
  • Version 19
This page is also available for…
Comments
Click [Add] to post a comment