SDGetAliasRelList [ HP System Dictionary XL Intrinsics ] MPE/iX 5.0 Documentation
HP System Dictionary XL Intrinsics
SDGetAliasRelList
Retrieves all relationships of a specified relationship type that use the
input alias name of a specified alias type attribute.
Syntax
SDGetAliasRelList (Dcb,Alias,AliasAttribute, RelationshipType,
RelationshipClass,RetrievalID,
Entitylist,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.
RelationshipType Required input; type = RelationshipTypeList
This parameter specifies the relationship type
of the relationships to be retrieved.
RelationshipClass Required input; type = NameOrNumberType
This parameter specifies the class of the
relationship type. Blanks or a 0 may be
specified for this parameter when the entity
types specified in the RelationshipType
parameter uniquely identify a relationship
type.
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 relationships
of the specified relationship type that use the
specified alias name.
To find the first relationship, initialize the
first four bytes of parameter to a binary zero.
To find additional relationships, call this
intrinsic once for each relationship to be
returned.
EntityList Output; type = EntityListOutType
This parameter returns the names of all the
entities in the specified relationship on
successful completion 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 relationship 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 relationships accessible by the current scope will be
retrieved.
MPE/iX 5.0 Documentation