<Connection variable>.InfoViewRights (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

<Connection variable>.InfoViewRights (Function)

In french: <Variable Connexion>.InfoDroitVue

Available only with this kind of connection

Gets the rights granted to a user or group on an SQL view or on a materialized view.

Example

// Describe the connection
MyConnection is Connection

sRights is string
sARight is string
// Retrieves the read/add rights granted to the user named Moore 
// on MyCustomerView found in MyDatabase
sRights = MyConnection.ViewRightInfo("Smith", hReadRight + hAddRight, "MyBase", "MyClientView")
sARight = ExtractString(sRights, firstRank, TAB)
WHILE sARight <> EOT
	SWITCH sARight
		CASE hAllowed
		...
		CASE hForbidden
		...
		CASE hInherit
		... 
	END
	sARight = ExtractString(sRights, nextRank, TAB)
END

Syntax

<Result> = <Connection>.InfoViewRights(<User/Group> , <Rights> , <Database> , <View> [, <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.
The requested information depend according to the parameter <Display mode of result>:
In hDefault mode, <Result> is a list of values separated by tabs.
<Value of rights 1> + TAB + ... + TAB + <Value of rights N>

where <Value of rights> corresponds to the value of the rights requested by the <Rights> parameter. 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 right is undefined at this level for the user (or the group to which they belong). The HFSQL server uses the right defined at the top level for the user (or the group to which the user belongs). For a view, the HFSQL server uses the right defined for the user (or the group to which the user belongs) at database level.
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 considered correspond to the constants used in the <Droits> parameter, and the values of the right correspond to the constants hAutorisé, hInterdit, or hHérité (see table above).

<Connection>: Connection variable

Name of the Connection variable that describes the connection for which the rights of a user or group of users must be known.

<User/Group>: Character string

Name of the user or group whose rights you want to get.

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

List of rights to find:
hRightsAll List of all the rights.
It is advisable to use this constant in display mode hDetail or hEffective + hDetail.
hRightsChangeRights Rights to change rights.
hRightsDelete Rights to delete records from a view.
hRightsDeleteView Rights to delete a view.
hRightsInsert Rights to add records to a view.
hRightsMaintenance Rights to start a reindex operation or a statistical calculation on a materialized view.
hRightsRead Rights to read the records of a view.
hRightsUpdate Rights to modify the records of a view.

<Database>: Character string

Name of the database containing the SQL or materialized view 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.

<View>: Character string

Name of the SQL view or materialized view on the server 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 that will be actually granted to the user or to the group on the view. 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.

Component: wd300hf.dll