LOCATION Object
- Last UpdatedMar 24, 2023
- 1 minute read
Members
|
Name |
Type |
Purpose |
|---|---|---|
|
Name |
STRING |
Location name. |
|
Description |
STRING |
Description, up to 120 characters. |
|
Locid |
STRING |
Location identifier. |
|
Refno |
STRING |
STRING containing Database reference no. |
|
IsCurrent |
BOOLEAN |
True for the current Location. |
Methods
|
Name |
Result |
Purpose |
|---|---|---|
|
LOCATION(DBREF) |
LOCATION |
Returns a LOCATION object, given a DBREF. |
|
LOCATION(STRING) |
LOCATION |
Returns a LOCATION object, given a name or reference number (Global projects only). |
|
Dblist() |
ARRAY OF DB |
Array of DB objects for Allocated DBs. This method does not modify the original object. |
|
Sessions() |
ARRAY OF SESSIONS |
Return array of all Sessions extracted from COMMs DB at the Location. This method does not modify the original object. |
|
String() |
STRING |
STRING containing Location name. This method does not modify the original object. |
Note:
The Sessions() method provides information required for remote expunging. This method will cause
daemon activity for locations other than the current location.
You can use the constructors in the following ways:
!D = OBJECT LOCATION(!!CE)
!D = OBJECT LOCATION(!!CE.Name)
!D = !!CE.LOCATION()!D = !!CE.Name.LOCATION()
In all cases, '!!CE' is assumed to be a DB database element and '!!CE.Name' is a STRING object containing the element’s name.
These methods should assist performance improvements to AppWare by making it easier to get from Database element to Object.