HModifyFileRights (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

Management of databases

HFSQL functions

HFSQL Client/Server functions

HModifyFileRights

Presentation

Example

When is the modification of rights performed?

HAddScheduledOptimization

HCS.Timeout (Variable)

HDeleteScheduledBackup

HDeleteScheduledOptimization

HExecuteScheduledBackup

HExecuteScheduling

HInfoBackup

HInfoDatabaseProperty

HListScheduledOptimization

HModifyDatabaseProperty

HModifyDatabaseRights

HModifyFileProperty

HModifyFileRights

HModifyGroup

HModifyScheduledBackup

HModifyScheduledOptimization

HModifyScheduling

HModifyServerProperty

HNotifAddEmailRecipient

HNotifConfigure

HNotifDeleteCCRecipient

HNotifDeleteEmailRecipient

HNotifListCCRecipient

HNotifListEmailRecipient

When is the modification of rights performed?

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HModifyFileRights (Function)

In french: HModifieDroitFichier

Available only with this kind of connection

Modifies the rights granted to a user or to a group on a HFSQL Client/Server data file.

Note: To find out the rights granted to a group or to a user on a HFSQL Client/Server data file, use HInfoFileRights.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Note: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 22 and later

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available for the Java applications.

New in version 22

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available for the Java applications.

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available for the Java applications.

Example

// Copy the rights from a user to another one
sRights is string
sRights = HInfoFileRights("MyConnection", "Smith", ...
hRightsRead + hRightsInsert, "MyDatabase", "MyFile.fic")
HModifyFileRights("MyConnection", "Doe", hRightsRead + hRightsInsert, ...
sRights, "MyDatabase", "MyFile.FIC")

Syntax

<Result> = HModifyFileRights(<Connection name> , <Name of user/group> , <Rights to modify> , <New values> , <Database> , <File name>)

<Result>: Boolean

True if the rights have been modified,
False otherwise. HErrorInfo is used to identify the error.
No modification is performed if the new value is already assigned to the specified rights.
Note: An error ("Unknown user" or "Unknown group") will be returned by HErrorInfo if the current user has no rights to see the users (hRightsSeeUser constant) and if he wants to get information about another user or another group.

<Connection name>: Character string (with or without quotes)

Name of the connection for which the rights granted to a user or to a group of users must be modified. This connection was defined in the data model editor, or by HDescribeConnection or HOpenConnection.

<Name of user/group>: Character string (with or without quotes)

Name of the user or group whose rights must be modified.

<Rights to modify>: Integer constant (or combination of constants)

List of rights to modify:
hRightsInsert Rights to add new records into a data file.
hRightsLock Rights to lock the data files or the records of a data file.
hRightsChangeRights Rights to change the rights.
hRightsChangeLink Rights to modify the integrity rules on a data file.
hRightsChangeOwner Rights to modify the owner of an element.
hRightsManageDuplicate Rights to enable and disable the management of duplicates.
hRightsRead Rights to read the records of a data file.
hRightsMaintenance Rights to start a re-index operation or to perform statistical calculations on a data file.
hRightsAutoModif Rights to perform the automatic modification of data files on a data file.
hRightsUpdate Rights to modify the records of a data file.
hRightsDelete Rights to delete the records from a data file.
hRightsDeleteFile Rights to delete a data file (HDeleteFile).

<New values>: Integer constants

List of new values for the modified rights. New values must be assigned to all the rights specified in <Rights to modify> (in the same order).
If a single value is indicated in this parameter, it will be assigned to all the rights specified in <Rights to modify>.
The possible values are as follows:
hAllowed The relevant rights are granted to the user or to the group.
hForbidden The relevant rights are not granted to the user or to the group.
hInherit The user will inherit from the value of the rights granted to the user group to which he belongs.

<Database>: Character string (with or without quotes)

Name of the database containing the data file for which the rights must be modified. If the database corresponds to the database defined in the connection, this parameter can correspond to an empty string (""). A WLanguage error occurs if no database is defined in the connection and if this parameter corresponds to an empty string.

<File name>: Character string (with or without quotes)

Name of the data file for which the rights must be modified.

Remarks

When is the modification of rights performed?

The modification of rights is effective as soon as HModifyFileRights is run for the users who are connected and affected by the modification. There is no need to restart the server to take the new rights into account.

Component : wd240hf.dll