HModifyItemRights (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL Client/Server functions

When are rights changed?

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HModifyItemRights (Function)

In french: HModifieDroitRubrique

Available only with this kind of connection

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

Example

// Copy the rights from a user to another one
sRights is string
sRights = HInfoItemRights("MyConnection", "Smith", hRightsUnmask, "MyDatabase", "MyFile.fic", "MyItem")
HModifyItemRights("MyConnection", "Davon", hRightsUnmask, sRights, "MyDatabase", "MyFile.fic", "MyItem")

Syntax

<Result> = HModifyItemRights(<Connection> , <User> , <Right to modify> , <New value> , <Database> , <File> , <Item>)

<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.
Remark: HErrorInfo will return "Unknown user" or "Unknown group" if the current user tries to access information about a specific user or group but does not have enough permissions (hRightsSeeUser constant).

<Connection>: Character string or Connection variable

Connection for which the rights granted to a user or group of users should be modified. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a variable of type Connection.

<User>: Character string

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

<Right to modify>: Integer constant

Right to modify:
hRightsUnmask Rights to unmask an item.

<New value>: Integer constant

New value for the right. The possible values are as follows:
hAllowed The relevant rights are granted to the user or group.
hForbidden The relevant rights are not granted to the user or group.
hInherit The user will inherit the right granted to the group to which they belong.

<Database>: Character string

Name of the database containing the data file item for which to modify the rights.
If the database corresponds to the one 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>: Character string

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

<Item>: Character string

Name of the item for which the rights should be modified.

Remarks

When are rights changed?

Rights are modified when HModifyItemRights is run. There is no need to restart the server to apply the new rights.

Business / UI classification: Business Logic

Component: wd300hf.dll