HP 3000 Manuals HP 3000 Manuals
SDGetRelList
Retrieves all relationships of the specified relationship type which are
accessible by the current scope.
Syntax
SDGetRelList (Dcb,RelationshipType,RelationshipClass,AccessSet,
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.
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.
AccessSet Required input by value; type = 4 byte Integer
This parameter specifies the set of
relationships to return. This set may include
some or all of the relationships of the
specified type in the dictionary, and is
decoded as follows:
Note : Bit 0 is the rightmost bit.
Bit 0 When set, specifies
retrieval of all
relationships owned
by the current scope.
Bit 1 When set, specifies
retrieval of all
relationships
accessible by the
scope through a
relationship/scope
association.
Bit 2 When set, specifies
retrieval of all
relationships which
are public, and not
owned by or
associated to the
current scope.
Note: When this bit
is set, and if the
current scope is the
DA scope, this
intrinsic will return
all relationships not
owned by the DA
scope.
Bits 3-31 Set to zero
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.
To find the first relationship, initialize the
first four bytes of this 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
entities in the relationship.
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 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 a scope with Read capability.
3. Only relationships accessible by the current scope will be
retrieved.