SDGetRelScopeList [ HP System Dictionary XL Intrinsics ] MPE/iX 5.0 Documentation
HP System Dictionary XL Intrinsics
SDGetRelScopeList
Retrieves all the scopes which are explicitly associated to a
relationship.
Syntax
SDGetRelScopeList (Dcb,RelationshipType,RelationshipClass,
EntityList,RetrievalID,Scope,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 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 relationship whose
associated scopes will 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 scopes
associated with this relationship.
To find the first scope, initialize the first
four bytes of this parameter to a binary zero.
To find additional scopes call this intrinsic
once for each scope to be returned.
Scope Output; type = NameType
This parameter returns the name of one scope
explicitly associated with the 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 scope 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 the relationship's owner scope.
MPE/iX 5.0 Documentation