gpwActivateUser (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / User Groupware functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gpwActivateUser (Function)

In french: gpwActiveUtilisateur

Validates a new user in the User Groupware database by activating the user.

Depending on the new user validation mode defined on the administration page, you can:

send an email to the user asking them to click a link to validate their subscription,
validate the user directly.

Example

// New user values
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)
	// Activate by email
	CASE gpwActivationByEmail
		PopupDisplay(POPUP_ValidateSubscription)

	// Activate immediately
	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

Syntax

<Result> = gpwActivateUser(<Identifier>)

<Result>: Integer constant

Activation result:
gpwActivationByEmail The user is activated by email. An email is automatically sent (the email characteristics are defined in the administration page).
gpwActivationImmediate The user is immediately activated.
gpwError Activation error.

<Identifier>: Character string

Username or user's email address.

Remarks

If an error occurs, the ErrorOccurred variable is set to True.

Business / UI classification: Neutral code

Component: wd300gpu.dll