HP 3000 Manuals HP 3000 Manuals
SDFindRelList
Retrieves all relationships in the dictionary which include at least the
entities specified in a search pattern.
Syntax
SDFindRelList (Dcb,RelationshipType,RelationshipClass,
EntitySearchList,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
to use.
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.
EntitySearchList Required input; type = EntityListType
This parameter identifies some or all of the
relationships of the relationship type to
return, by specifying the entities to search
on. See the details under Discussion.
RetrievalID Required input; Output; type = RetrievalIDType
This parameter issued internally to pass
information between multiple calls of this
intrinsic, to retrieve the subset of
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 relationships which
meet the criteria being searched on (i.e.
relationship type and entity search list) to
which the current scope has access.
Status Output; type = StatusType This parameter
contains information indicating the success or
failure of the intrinsic call. This
information is detailed in Table 3-1, located
in Section 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 |
| | |
----------------------------------------------------------------------
| | |
| 21 - 24 | Internal entity number of the entity that correspond|
| | to the first places holder. * |
| | |
----------------------------------------------------------------------
* See Discussion, #3.
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. Only
relationships accessible by the current scope will be retrieved.
3. The entities used in the EntitySearchList parameter must
correspond to the order of the entity types in the
RelationshipType parameter. If all of the entities in a
relationship are not specified, a place-holder must be inserted
for each missing entity. This place holder must be a
question-mark (? ) if this parameter is a name list, or a
negative 1 (-1) if it is a number list.
Example : If only entities 1, 2 and 4 of a 4-way relationship are
specified, a place-holder must be inserted in place of entity 3,
as shown:
Entity1 Entity2 ? Entity4