SDGetAliasEntList [ HP System Dictionary XL Intrinsics ] MPE/iX 5.0 Documentation
HP System Dictionary XL Intrinsics
SDGetAliasEntList
Retrieves all entities of a specified entity type that use the alias
input name of a specified alias type attribute.
Syntax
SDGetAliasEntList (Dcb,Alias,AliasAttribute,EntityType,
RetrievalID,Entity,Status)
Parameters
Dcb Required input; type = DcbType
This parameter passes information about the
dictionary to this intrinsic. It is
initialized by the SDOpen intrinsic.
Alias Required input; type = AliasType
This parameter specifies the alias name of the
specified alias attribute.
AliasAttribute Required input; type = NameOrNumberType
This parameter specifies the name or internal
number of the specified alias attribute.
EntityType Required input; type = NameOrNumberType
This parameter specifies the entity type of the
entities 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 entities of
the specified entity type that use the
specified alias name.
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.
Entity Output; type = NameType
This parameter returns the name of one entity
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 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 capability.
3. Only entities accessible by the current scope will be retrieved.
MPE/iX 5.0 Documentation