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
HInfoDatabaseRights (Function)
In french: HInfoDroitBaseDeDonnées
HFSQL Client/ServerAvailable only with this kind of connection
Allows you to find out the rights granted to a user or to a group on a database.
TheRights is string
ARight is string
// Retrieves the read/add rights granted to the user named Moore 
// on MyDatabase
TheRights = HInfoDatabaseRights("CNT", "Smith", ...
hRightsRead + hRightsInsert, "MyDatabase")
ARight = ExtractString(TheRights, firstRank, TAB)
WHILE ARight <> EOT
SWITCH ARight
CASE hAllowed
...
CASE hForbidden
...
CASE hInherit
... 
END    
ARight = ExtractString(TheRights, nextRank, TAB)
END
Syntax
<Result> = HInfoDatabaseRights(<Connection> , <User/Group> , <Rights> , <Database> [, <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:
    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

    where:
    • <Relevant rights> corresponds to one of the constants used in the <Rights> parameter.
    • <Value of rights> corresponds to one of the 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.
<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.
hRightsBackupRights to perform a backup.
hRightsChangeLinkRights to modify the integrity rules on a data file.
hRightsChangeOwnerRights to modify the owner of an element.
hRightsChangeRightsRights to change rights.
hRightsConnectionRights to connect to a server (encrypted or unencrypted connection).
hRightsCreateFileRights to create a data file (with HCreation).
hRightsCreateViewRights to create a view.
hRightsDebugRights to debug the stored procedures.
hRightsDeleteRights to delete the records from a data file.
hRightsDeleteDBRights to delete a database.
hRightsDeleteFileRights to delete a data file (HDeleteFile).
hRightsDeleteViewRights to delete a view.
hRightsEncryptedConnectionRights to connect to a server (encrypted connection only).
hRightsInsertRights to add new records into a data file.
hRightsLockRights to lock the data 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.
hRightsManageIntegrityRights to enable and disable the management of integrity.
hRightsManageProcedureRights to add, modify and delete the sets of procedures.
hRightsManageTriggerRights to add, enable and delete server triggers.
hRightsNoDatabaseAccessRights to prevent access to a database (HNoDatabaseAccess and HEndNoDatabaseAccess).
hRightsReadRights to read the records of a data file.
hRightsRunProcedureRights to run a stored procedure.
hRightsUpdateRights to modify the records of a data file.
<Database>: Character string
Name of the database for which the rights are requested.
<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 that will be actually granted to the user or to the group on the database. 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 of users on a database, use HModifyDatabaseRights.
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