HInfoItemRights (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HInfoItemRights (Function)

In french: HInfoDroitRubrique

Gets the rights granted to a user or group on an item.

Example

sRights is string
// Gets data unmasking rights granted to "Smith"
// on the "MyItem" item of the "MyFile.fic" file in "MyDatabase"
sRights = HInfoItemRights("Connect", "Smith", hRightsUnmask, "MyDatabase", "MyFile.fic", "MyItem")
SWITCH sRights
	CASE hAllowed
	...
	CASE hForbidden
	...
	CASE hInherit
	... 
END

Syntax

<Result> = HInfoItemRights(<Connection> , <User/Group> , <Rights> , <Database> , <Data file> , <Item> [, <Display mode>])

<Result>: Character string

Requested information,
Empty string ("") if an error occurred.
"Unknown user" or "Unknown group" if the current user has no permissions to see other users (hRightsSeeUser constant) and wants to get information about another user or group.
In hDefault mode, <Result> is a list of values separated by tabs. Each value in the list corresponds to the rights requested by <Rights>. The values in the list can correspond to one of the following constants:
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 belongs to at least one group to which the relevant rights were granted.
This constant is returned only if the display mode is not set to hEffective.

In hDetails mode, <Result> is a list of values with the following format:
<Relevant rights 1> + TAB + <Value of rights 1> + CR + ...
<Relevant rights N> + TAB + <Value of rights N> + CR

The rights correspond to the constants used in the <Rights> parameter and the values of the rights correspond to the hAllowed, hForbidden or hInherited constant (see the above table).

<Connection>: Character string or Connection variable

Connection for which the rights of a user or group of users must be known. 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/Group>: Character string

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

<Rights>: Integer constant

List of rights to find:
hRightsUnmask Rights to unmask an item.

<Database>: Character string

Name of the database containing the data file item for which to get 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.

<Data file>: Character string

Name of the HFSQL data file containing the item for which to get the rights. The extension of the data file must be specified.

<Item>: Character string

Name of the item for which to get the rights.

<Display mode>: Optional Integer constant

Result display mode:
hDefault
(Default value) The rights returned do not take the inherited rights into account (rights granted to the groups to which the user belongs).
If no rights were defined, the value will be set to hInherit.
<Result> contains the values of the requested rights (in the same order).
hDetails Same as hDefault.
<Result> contains the rights and there value.
hEffective The rights returned correspond to the rights actually granted to the user or to the group on the data file. Inherited rights are taken into account (for example, rights granted to the groups to which the user belongs).
hEffective + hDetails Same as hEffective.
<Result> contains the rights and there value.

Remarks

To change the rights granted to a user or group on an item, use HModifyItemRights.

Business / UI classification: Business Logic

Component: wd300hf.dll