PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US

WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
HInfoFileRights (Function)
In French: HInfoDroitFichier
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 HFSQL Client/Server data file.
Versions 17 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Note: From version 19, HFSQL is the new name of HyperFileSQL.
Versions 22 and later
Android Widget This function is now available in Android Widget mode.
WINDEVJava This function is now available for the Java applications.
Android This function is now available for the Android applications.
New in version 22
Android Widget This function is now available in Android Widget mode.
WINDEVJava This function is now available for the Java applications.
Android This function is now available for the Android applications.
Android Widget This function is now available in Android Widget mode.
WINDEVJava This function is now available for the Java applications.
Android This function is now available for the Android applications.
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 Name> , <Name of User/Group> , <Rights> , <Database> , <File Name> [, <Display Mode of Result>])
<Result>: Character string
  • Requested information,
  • Empty string ("") if an error occurred.
  • "Unknown user" or "Unknown group" if the current user does not have the rights to see the users (hRightsSeeUser constant) and if he wants to get information about another user or another group.
In hDefault mode, <Result> is a list of values separated by tabulations (TAB). Each value found in this list corresponds to the rights requested by <Rights>. Each value found in this list can correspond to one of the following constants:
hAllowedThe relevant rights are granted to the user or to the group.
hForbiddenThe relevant rights are not granted to the user or to the group.
hInheritThe user belongs to at least one group to which the relevant rights was 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 Rights1> + 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 Name>: Character string (with or without quotes)
Name of the connection for which the rights granted to a user or to a group of users are requested. This connection was defined in the data model editor, or by HDescribeConnection or HOpenConnection.
<Name of User/Group>: Character string (with quotes)
Name of the user or name of the group whose rights are requested.
<Rights>: Integer constant (or combination of constants)
List of rights to find:
hRightsInsertRights to add new records into a data file.
hRightsLockRights to lock the files or the records of a data file.
hRightsChangeRightsRights to change the rights.
hRightsChangeLinkRights to modify the integrity rules on a data file.
hRightsChangeOwnerRights to modify the owner of an element.
hRightsManageDuplicateRights to enable and disable the management of duplicates.
hRightsReadRights to read the records of a data file.
hRightsMaintenanceRights to start a re-index operation or to perform statistical calculations on a data file.
hRightsAutoModifRights to perform an automatic modification on a data file.
hRightsUpdateRights to modify the records of a data file.
hRightsDeleteRights to delete the records from a data file.
hRightsDeleteFileRights to delete a data file (HDeleteFile)
hRightsAllList of all the rights.
We recommend that you use this constant in hDetails or hEffective + hDetails display mode.
<Database>: Character string (with quotes)
Name of the database containing the data file for which the rights are requested. If the database corresponds to the database 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 Name>: Character string (with quotes)
Name of the HFSQL file found on the server for which the rights are requested. The extension of the data file must be specified.
<Display Mode of Result>: Optional Integer constant
Mode for displaying the result:
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 its 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 its value.
Remarks
To modify the rights granted to a user or to a group on a data file, use HModifyFileRights.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230hf.dll
Windows Mobile wp230hf.dll
Java wd230java.jar
Linux wd230hf.so
Android wd230android.jar
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment