HP 3000 Manuals HP 3000 Manuals
SDGetSynonymList
Retrieves all the synonyms of an entity.
Syntax
SDGetSynonymList (Dcb,EntityType,Entity,RetrievalID,Synonym,Status)
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
entity whose synonyms are to be retrieved.
Entity Required input; type = NameOrNumberType
This parameter specifies the entity whose
synonyms are 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 synonyms of
the specified entity.
To find the first synonym, initialize the first
four bytes of this parameter to a binary zero.
To find additional synonyms call this intrinsic
once for each synonym to be returned.
Synonym Output; type = NameType
This parameter returns one synonym name 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.
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 access to the specified
entity.