ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / Managing databases / HFSQL / HFSQL Client/Server functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Allows you to find out the rights granted to a user or to a group on an HFSQL Client/Server data file.
sRights is string
sARight is string
// Retrieves the read/add rights granted to the user named Moore
// on the MyFile.fic file found in MyDatabase
sRights = HInfoFileRights("CNT", "Moore", hRightsRead + hRightsInsert, "MyDatabase", "MyFile.fic")
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> = HInfoFileRights(<Connection> , <User/Group> , <Rights> , <Database> , <Data file> [, <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:
hAllowedThe relevant rights are granted to the user or group.
hForbiddenThe relevant rights are not granted to the user or group.
hInheritThe 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:
<User/Group>: Character string
Name of the user or group whose rights must be known.
<Rights>: Integer constant (or combination of constants)
List of rights to find:
hRightsAllList of all the rights.
We recommend that you use this constant in hDetails or hEffective + hDetails display mode.
hRightsAutoModifRights to perform an automatic modification on a data file.
hRightsChangeLinkRights to modify the integrity rules on a data file.
hRightsChangeOwnerRights to modify the owner of an element.
hRightsChangeRightsRights to change rights.
hRightsDeleteRights to delete the records from a data file.
hRightsDeleteFileRights to delete a data file (HDeleteFile)
hRightsInsertRights to add new records into a data file.
hRightsLockRights to lock the files or the records of a data file.
hRightsMaintenanceRights to start a re-index operation or to perform statistical calculations on a data file.
hRightsManageDuplicateRights to enable and disable the management of duplicates.
hRightsReadRights to read the records of a data file.
hRightsUpdateRights to modify the records of a data file.
<Database>: Character string
Name of the database containing the data file for which the rights are requested.
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 on the server for which rights are requested. The extension of the data file must be specified.
<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).
hDetailsSame as hDefault.
<Result> contains the rights and there value.
hEffectiveThe rights returned correspond to the rights actually granted to the user or to the group on the data file. The inherited rights are taken into account (rights granted to the groups to which the user belongs for example).
hEffective + hDetailsSame as hEffective.
<Result> contains the rights and there value.
Remarks
To modify the rights of a user or group on a data file, use HModifyFileRights.
Component: wd290hf.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 09/07/2023

Send a report | Local help