gpwOpen (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

How to use the gpwOpen function?
Pre-launched sessions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gpwOpen (Function)

In french: gpwOuvre

Not available

Not available with these kinds of connection

Opens the User Groupware login window or page.

Remark: This function is required only if the User Groupware was integrated with the "Manual start" option. If the option "Automatic start" has been selected, this function is ignored.

Example

// Opens the User Groupware login window
nRes is int = gpwOpen("c:\GpwUser")
// If the login failed 
IF nRes <> gpwOk THEN 
	SWITCH nRes 
		CASE gpwCancel: Info("The Cancel button was clicked.")
		CASE gpwError: Error("Error while initializing the groupware.")
		CASE gpwUnknownUser: Error("Unknown user.")
		CASE gpwInvalidPassword: Error("Invalid password")
	END 
	EndProgram()
END 
// Retrieve the user's first name 
FirstName is string = gpwGetUserInfo(gpwInfoFirstName)
Info("Welcome" + FirstName)

Syntax

Syntax of the new User Groupware Hide the details

<Result> = gpwOpen([<Groupware files directory>])

<Result>: Integer constant

Result when the login window/page opens.
gpwCancel The user clicked the "Cancel" button in the Groupware login window.
gpwError An error occurred. For more details, use the ErrorInfo function.
gpwInvalidPassword The password is not valid. It does not match the user password defined in the groupware database.
gpwOk The user is logged in.
gpwUnknownUser The user is not listed in the User Groupware database.

<Groupware files directory>: Optional character string

These data files are used to manage users and their rights. By default, these data files are created in a subdirectory of your project (EXE\GPW_<Project name> directory).
By default, these data files are created on the server in a subdirectory of your database: .\GPW_<Project name> directory.

If this parameter is an empty string ("") or is not specified, the default directory of the User Groupware will be used.
If this parameter is a dot ("."), the User Groupware data files will be created on the server at the root of the database.

Specific syntax for Android and iOS applications Hide the details

gpwOpen(<WLanguage procedure> [, <User database>])

<WLanguage procedure>: Procedure name

Name of the WLanguage procedure ("callback") called when the login window is closed.
This procedure has the following format:
PROCEDURE <Procedure name>(<Connection> is boolean)
The <Connection> is a boolean:
True if the user is logged in,
False if the user is not logged in.

<User database>: Integer constant

Database of users and rights to use:
gpwDatabaseDefault The database of users and rights depends on the application start mode:
if the application is launched in test mode (via the simulator or directly on the device with WMDev), the test database will be used.
if the application is launched from the version deployed on the mobile device, or an Android emulator, the production database will be used.
gpwDatabaseProduction Forces the use of the production database regardless of the application start mode.
gpwDatabaseTest Forces the use of the test database regardless of the application start mode.

Syntax of the former User Groupware (kept for backward compatibility) Hide the details

<Result> = gpwOpen([<Rights file directory> [, <User files directory>]])

<Result>: Integer constant

Result when the login window/page opens.
gpwCancel The user clicked the "Cancel" button in the Groupware login window.
gpwError An error occurred. For more details, use the ErrorInfo function.
gpwInvalidPassword The password is not valid. It does not match the user password defined in the groupware database.
gpwOk The user is logged in.
gpwUnknownUser The user is not listed in the User Groupware database.

<Rights file directory>: Optional character string

These data files are used to manage the rights granted to the users for the different windows of the application. These files are specific to the application. By default, these data files are created in a subdirectory of your project (EXE\GPW_<Project name> directory).
By default, these data files are created on the server in a subdirectory of your database: .\GPW_<Project name> directory.

If this parameter is an empty string ("") or is not specified, the default directory of the User Groupware will be used.
If this parameter is a dot ("."), the User Groupware data files will be created on the server at the root of the database.

<User files directory>: Optional character string

These data files can be common to several applications. By default, these data files are created in a subdirectory of your project (EXE\GPW_<Project name> directory). You can define the location of the User Groupware files common to several applications. In this case, you must specify the path of the data files to be used.
By default, these data files are created on the server in a subdirectory of your database: .\GPW_<Project name> directory.

If this parameter is an empty string ("") or is not specified, the default directory of the User Groupware will be used.
If this parameter is a dot ("."), the User Groupware data files will be created on the server at the root of the database.

Remarks

How to use the gpwOpen function?

gpwOpen allows you to define the User Groupware startup mode. This allows you to perform other actions before opening the User Groupware login window or page: execute code, open windows or pages, etc.

Usage example of this function: in a multilingual application that uses the User Groupware, the first window or page of the application is used to choose the runtime language. When creating the application, you must:

choose not to automatically start the User Groupware when it is integrated
open the window or page for language selection as first application window, then call the login window or page with gpwOpen.

If the User Groupware is enabled in "Manual start" mode, the following operations must be performed:

Do not define a first project window.
Call gpwOpen in the "Initialization" event of the project.
Open the first project window from the WLanguage code of the procedure passed as a parameter to gpwOpen.

Pre-launched sessions

If your project uses pre-launched sessions, this function must not be used in the project initialization event. This function must be used in the "Initialization in pre-launched session mode" event.

Business / UI classification: Neutral code

Component: wd300gpu.dll