SDGetLocalEntList [ HP System Dictionary XL Intrinsics ] MPE/iX 5.0 Documentation
HP System Dictionary XL Intrinsics
SDGetLocalEntList
Retrieves all local entities that are linked to the specified common
entity.
Syntax
SDGetLocalEntList (Dcb,EntityType,Entity,RetrievalID,LocalEntity,
LocalDomain,LocalVersion,Status)
Parameters
Dcb Required input; type = DcbType
This parameter passes information about the
dictionary to this intrinsic. It is
initialized by the SDOpen intrinsic.
EntityType Required input; type = NameOrNumberType
This parameter specifies the entity type of the
common entity.
Entity Required input; type = NameOrNumberType
This parameter specifies the common entity
whose local entity list is to be retrieved.
RetrievalID Required input; Output; type = RetrievalIDType
This parameter is used internally to pass
information between multiple calls of this
intrinsic, to retrieve all of the local
entities of the specified entity type that are
linked to the common entity.
To find the first entity, initialize the first
four bytes of this parameter to a binary zero.
To find additional entities, call this
intrinsic once for each entity to be returned.
LocalEntity Output; type = NameType
This parameter returns one name of a local
entity for each successful call of this
intrinsic.
LocalDomain Output; type = NameType
This parameter returns one name of a local
domain that the local entity is in, for each
successful call of this intrinsic.
LocalVersion Output; type = NameType
This parameter returns one name of a version of
a local domain that the local entity is in, for
each successful call of this intrinsic.
Status Output; type = StatusType
This parameter contains information indicating
the success or failure of the intrinsic call.
This information is detailed in Table Table
3-1, located in Chapter 3 of this manual.
If this intrinsic is successful, the Status
parameter contains the following information,
in addition to the description contained in
Table Table 3-1.
----------------------------------------------------------------------
| | |
| Bytes | Contain |
| | |
----------------------------------------------------------------------
| | |
| 17 - 20 | Internal local entity number |
| | |
----------------------------------------------------------------------
Discussion
The following restrictions apply when using this intrinsic:
1. Open mode--The dictionary must be opened in Shared Read mode,
Shared Read-Only mode, Shared Update mode, or Exclusive Update
mode.
2. Security--The current scope must be either the Dictionary
Administrator scope or any scope with at least Read access to the
common entity.
3. The current domain must be the common domain.
MPE/iX 5.0 Documentation