HP 3000 Manuals HP 3000 Manuals
SDGetEntList
Retrieve all entities of the specified entity type which are accessible
by the current scope.
Syntax
SDGetEntList (Dcb,EntityType,AccessSet,RetrievalID,Entity,Status)
Parameters
Dcb Required input; type = DcbType
This parameter passes information about the
dictionary to this intrinsic. It is
initialized by the SDOpen intrinsic.
EntityType Required input; type = NameOrNumberType
This parameter specifies the entity type of the
entities to be retrieved.
AccessSet Required input by value; type = 4 byte Integer
This parameter specifies the set of entities to
return. This set may include some or all of
the entities 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 entities owned by the current
scope.
Bit 1 When set, specifies retrieval of
all entities accessible by the
scope through an entity/scope
association.
Bit 2 When set, specifies retrieval of
all entities 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, then this intrinsic will
return all entities 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 the entities of the
specified entity type and access set in the
dictionary.
To find the first entity, initialize the first
four bytes of this parameter to a binary zero.
To find additional entities, call this
intrinsic once for each entity to be returned.
Entity Output; type = NameType
This parameter returns the name of an entity of
the specified entity type 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 entity 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 entities accessible by the current scope will be retrieved.