gpwActivateUser (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gpwActivateUser (Function)

In french: gpwActiveUtilisateur

Validates the creation of a new user in the database of user groupware by activating the user.

Depending on the validation mode of new users configured in the management page, you can:

send an email to the user and ask him to click a link in order to validate his subscription,
validate the user directly.

Versions 24 and later

This function is now available for WEBDEV sites in Linux.

New in version 24

This function is now available for WEBDEV sites in Linux.

Example

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

Syntax

<Result> = gpwActivateUser(<Identifier>)

<Result>: Integer constant

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

<Identifier>: Character string (with quotes)

Login or email of user.

Remarks

The ErrorOccurred variable is set to True if an error occurs.

Business / UI classification: Neutral code

Component: wd260gpu.dll