SDGetLocalRelList [ HP System Dictionary XL Intrinsics ] MPE/iX 5.0 Documentation
HP System Dictionary XL Intrinsics
SDGetLocalRelList
Retrieves all local relationships that are linked to the specified common
relationship.
Syntax
SDGetLocalRelList (Dcb,RelationshipType,RelationshipClass,EntityList
RetrievalID,LocalEntityList,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.
RelationshipType Required input; type = RelationshipTypeList
This parameter specifies the relationship type
of the common relationship.
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.
EntityList Required input; type = EntityListType
This parameter specifies the common
relationship whose local relationship 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
relationships of the specified relationship
type that are linked to the common
relationship.
To find the first local relationship,
initialize the first four bytes of this
parameter to a binary zero. To find additional
local relationships, call this intrinsic once
for each local relationship
LocalEntityList Output; type = EntityListOutType
This parameter returns one local relationship
for each successful call of this intrinsic.
LocalDomain Output; type = NameType
This parameter returns one name of a version of
a local domain that the local relationship is
in, for each successful call of this intrinsic.
LocalVersion Output; type = NameType
This parameter returns one name of a local
domain version of the local relationship 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 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 access to the
common relationship.
3. The current domain must be the common domain.
MPE/iX 5.0 Documentation