Request Access
- Last UpdatedJul 05, 2024
- 1 minute read
The function of this Business Logic Tier (BLT) is to set or clear an advisory flag on the specified record within the specified table.
Syntax
RequestAccess <tableName> <ptName> <action> <[ptName,action]>
Parameters
|
Name |
Description |
|---|---|
|
tableName |
The RealTime database (RTDB) table name. |
|
ptName |
The table row name. |
|
action |
Specifies the action required (set, clear, or test). |
Comments
RequestAccess sets, clears, or tests the status of the advisory flag on the specified record.
All applications that configure RTDB tables should obey the advisory flag and use the RequestAccess Remote Procedure Call (RPC).
Request access has the following return values:
-
0- the access request is successful or the flag is currently clear. If action ="set" and the accessFlag field is "clear", 0 is returned.
-
1 - the access request flag is currently set. If action = "test" or "set", and the accessFlag is "set", 1 is returned.
-
2 - the point does not exist.
-
3 - unknown access request action.
-
4 - VDB Library error.
-
Read only access allowed.
RequestAccess returns two columns of results. However, it returns one column if any of the following is true:
-
The tableName is incorrect or inaccessible.
-
One of the actions is invalid.
-
A single action was specified.
Multiple commands are primarily used to both clear one accessFlag and set the next accessFlag in a single operation.