Page History
...
The meaning of the response value depends on the service.
Parameters
Parameter | Description |
---|
@Service | The name of the service being requested. Required. |
@Params | Generic parameters. Refer to a specific service to determine the actual parameters used. |
Remarks
This module provides several useful services for high level interaction with database tables and rows.
Services
Service | Description |
---|
CalculateColumn | Usage: |
Comments: |
Called directly from within a calculation column. The name of the table and column is derived from the call stack and the associated table commuter, if it exists, is called with the appropriate arguments. Returns: | |
ClearTableHandle | Usage: Comments: Returns: |
A |
DeleteDataRow | Usage: |
|
Comments: |
Deletes a data row for the indicated |
Verify_LH
subroutine to check for GFEs. All results are stored in the SYSLHVERIFY table with a KeyID of VolumeLabel*DatabaseID*TableName. Returns the list of groups that have GFEs or returns an empty string if there are none. The list of GFEs or empty strings will themselves be @FM delimited to correspond with the tables passed into this service.Key ID and database table. Returns: | |
GetKeyIDLock | Usage: Comments: Returns: |
GetTableCommuter | Usage: Comments: Returns: |
GetTableHandle | Usage: Comments: Returns: |
GetTableNames |
Returns:
N/A
Usage: |
|
Comments: Returns: |
See comments. | |
GetTableProperties | Usage: |
Comments: Returns: |
The most current error message.
| ||||||||||||
GetUserLocks |
Usage: |
|
Comments: |
Note, this can only be done with the UD 5. This can also cause instability with the current session and may require the Task Manager to close the session. Returns: |
Returns a dynamic array of user lock information. |
IsKeyIDLocked | Usage: |
|
Comments: |
Returns a Boolean flag of the lock status for the indicated table and Key ID |
. Returns: |
See comments. |
IsKeyIDSelfLocked | Usage: |
|
Comments: |
Returns a Boolean flag of the self-lock status for the indicated table and Key ID |
. Returns: |
See comments |
ReadDataRow |
Usage: |
|
|
|
Comments: |
Reads a data row for the indicated Key ID and database table. Returns: |
The requested data row. | |
ReleaseKeyIDLock | Usage: |
|
Comments: |
release a semaphore lock on the indicated tablename and Key ID. Returns: |
A Boolean flag indicating if the lock release was successfully performed. | |
SearchIndex | Usage: |
|
Comments: |
Returns an @FM delimited list of Key IDs that match the search value. Returns: |
See comments | |
SetTableAlias | Usage: Comments: Returns: |
A Boolean flag indicating if the alias request was successfully performed. | |
UnlockKeyID | Usage: |
|
Comments: |
Attempts to unlock the indicated Key ID from the indicated Table Name. Note, this can only be done with the UD 5. Returns: |
A Boolean flag indicating if the unlock request was successfully performed. | |
VerifyLH | Usage: |
Returns:
N/A
GetTableCommuter
Usage:Database_Services('GetTableCommuter', TableName)
Comments:
Returns the name of the indicated table's commuter module if it exists. If it does not exist then an empty string will be returned.
Returns:
N/A
GetUserLocks
Usage:Database_Services('GetUserLocks')
Comments:
Returns a dynamic array of user lock information. Note, this can only be done with the UD 5. This can also cause instability with the current session and may require the Task Manager to close the session.
Returns:
N/A
IsKeyIDLocked
Comments: |
Performs a health check against the indicated tables and returns back any issues. Note: This uses the Returns: |
VerifyLHAll |
Usage: |
Comments: |
Returns:
N/A
IsKeyIDSelfLocked
Usage:Database_Services('IsKeyIDSelfLocked', TableName, KeyID)
Comments:
Returns a Boolean flag of the self-lock status for the indicated table and Key ID.
Returns:
N/A
UnlockKeyID
Performs a health check against all attached tables and returns back any issues. Returns: | |
WriteDataRow | Usage: |
Comments: |
Writes a data row for the indicated Key ID |
and database table. Returns: |
...
Params
The proper use of the generic arguments are defined in the definition of each service above.
...