SYNTAX:
xpxCheckInstanceAccessRights(currInst : GENERIC; requiredAccessCode : INTEGER; userId, groupId : GENERIC; options : INTEGER; VAR result : BOOLEAN; VAR lastCheckedInstance : GENERIC; VAR accessRole : INTEGER; VAR protection : INTEGER; VAR actualAccessRights : INTEGER) status : INTEGER;
To be completed.
The xpxCheckInstanceAccessRights function?.
The arguments of the function are:
...
Argument:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
FUNCTION xpxCheckInstanceAccessRights(currInst : GENERIC;
requiredAccessCode : INTEGER;
userId, groupId : GENERIC;
options : INTEGER;
VAR result : BOOLEAN;
VAR lastCheckedInstance : GENERIC;
VAR accessRole : INTEGER;
VAR protection : INTEGER;
VAR actualAccessRights : INTEGER)
status : INTEGER;
|
Checks whether an EDMuser/EDMgroup would have a requested access to a given protected instance.
Arguments
...
| 1 | Type | Name | Comment | ||||
| 2 | GENERIC | currInst | A numeric instanceID that uniquely identifies an instance in the EDMdatabase | that for which access is to be checked. This instanceID is defined when the actual instance is created by the xpxCreateInstance or xpxCreateInstanceBN function. | |||
| 3 | INTEGER | requiredAccessCode | One of the symbols from the following list;
| ,
| ,
| ,
| ,
|
| 4 | GENERIC | userId | Address of the variable that holds the numeric instanceID that uniquely identifies the EDMuser instance in the EDMdatabase | that defines the EDMuser of the caller, i.e. the EDMuser the caller is logged on the EDMserver | as. | ||
| 5 | GENERIC | groupId | A numeric groupID that uniquely identifies the edm_group instance in the EDMdatabase | ||||
| 6 | INTEGER | options | Specifies the current EDMexpressCompiler options. The <options> value should be specified as a bitwise OR of the options to enable. See the edmiExpressToHTML function for details of available options. All option names are defined in the header file sdai.h | ||||
result |
| ||||||
lastCheckedInstance |
| ||||||
accessRole |
| ||||||
protection |
| ||||||
actualAccessRights |
|
...
| see below | |||
| 7 | BOOLEAN | result | TRUE if the required access has granted granted. Otherwise FALSE. |
| 8 | GENERIC | lastCheckedInstance | When using option CHECK_FULL_PATH, the protected instance as well as the entire chain of parent protected instances will be checked. Checking will be done in the model to repository direction. If access to a protected model is checked and the model it self denies access, the instance Id returned in this variable will be the model Id. If access is denied by the protected parent repository, the repository Id will be returned herein. |
| 9 | INTEGER | accessRole | This variable receives an integer value that tells on what basis access was given or denied. Below is a list of possible values and their significance:
|
| 10 | INTEGER | protection | This variable will receive the full 15bit protection code of the protected instance returned in parameter lastCheckedInstance. |
| 11 | INTEGER | actualAccessRights | This variable will receive the actual 5bit protection code that was applied when access to the protected instance was either given or denied. Depending on the access role used, the protection code returned herein may be either owner protection, group protection, public protection or an individually set protection code. The protection code is a bitwise OR of any combination of the following symbols;
|
Return Value
...
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Options
...
| Option | Comment |
| CHECK_FULL_PATH | comment |
Example
...
| Code Block | ||
|---|---|---|
| ||
<Missing Example> |
See also
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|