<Source>.Password (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

When to use <Source>.Password?
Defining a password on a data file
Deleting the password defined on a data file
Managing passwords (OLE DB and Native Accesses)

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Source>.Password (Function)

In french: <Source>.MotDePasse

Available only with these kinds of connection

Defines the password used to create or open a data file. The password is stored and it will be used when opening or creating the data file if no password is specified.

Remarks:

Attention A password is required to encrypt data. The data encryption must be configured during the file description in the data model editor ("Details" tab).
This password can also be specified in the functions for creating the data file (<Source>.Creation, <Source>.CreateIfNotFound) and for opening the data file (<Source>.Open).
Encrypted files in an HFSQL connection: &nbspCaution: The order of use of functions for connecting to an HFSQL Client/Server database is important.. For more details, see Optimizing the connection times to the HFSQL Client/Server databases.

Example

// Open a data file with password and error check
Customer.Password("Password")
IF Customer.CreateIfNotFound() = False THEN
	Error("HFSQL error: " + HErrorInfo())
	RETURN
END
// <Source>.ErrorPassword is used to find out whether the error that occurred is a password error
IF Customer.CreateIfNotFound() = False THEN
	// Error details
	IF HErrorPassword() = True THEN
		Error("Invalid password")
		// Code to retry
	END
END

Syntax

<Result> = <Source>.Password([<Password>])

<Result>: Boolean

True if the password is saved,
False if an error occurred (insufficient memory for example). HError and HErrorInfo return more details about the problem.

<Source>: Type corresponding to the specified source

Name of data file that uses a password.
If the data file is declared with <Source>.DeclareExternal, <Source> corresponds to the name of the data file alias.

<Password>: Optional character string

Password associated with the data file.
If this parameter is not specified or is an empty string (""), no password is defined for the data file. The password size is not limited.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.
HFSQL data file password is case insensitive.

Remarks

When to use <Source>.Password?

<Source>.Password must be called:

before explicit opening or creation functions: <Source>.Open, <Source>.Creation, <Source>.CreateIfNotFound.
before the HFSQL functions that access the date files and that automatically open the data files if not already done (read, search, add, ...).

Remarks:

If a password is specified in the explicit opening or creation functions (<Source>.Open, <Source>.Creation, <Source>.CreateIfNotFound), the password specified in <Source>.Password is ignored.
HFSQL data file passwords are case insensitive.
To change a password on an existing data file or add a password to a data file created without a password, you must use <Source>.ChangePassword.

Defining a password on a data file

A data file will be protected by password if:

<Source>.Password was used before the function for creating the data file (<Source>.Creation and <Source>.CreateIfNotFound),
or the password has been specified directly in the data file creation function.

Note A data file can be password-protected without being encrypted, and vice versa. The password is independent of data encryption. The data encryption must be configured during the file description in the data model editor ("Details" tab).

Deleting the password defined on a data file

To delete a password on a data file, an automatic data file modification must be performed.

To do so, perform a modification in the analysis (modify the size of an item for example). In this case, an automatic data file modification will be proposed when the analysis is generated. You will be able to modify or delete the password associated with one or more data files.

If your data files are already deployed, specify that an automatic data file modification is required when creating the setup program. The password will be deleted or modified.

Attention: if you remove the password from your data files, don't forget to adapt your code.

Managing passwords (OLE DB and Native Accesses)

The password must be specified in the parameters of the connection.

Business / UI classification: Business Logic

Component: wd300hf.dll