HP 3000 Manuals HP 3000 Manuals
SDOpen
Opens a specified System Dictionary and sets the environment for the
current dictionary session.
Syntax
SDOpen (Dictionary,Scope,Password,OpenMode,NameMode,Domain,
Version,VersionStatus,Dcb,Status)
Parameters
Dictionary Required input; type = DictionaryName
This parameter specifies the dictionary to open. The
group and account names may vary, but the dictionary
name must be SYSDIC. Examples of possible dictionary
names are shown below.
* SYSDIC only, using logon Group and Account
* SYSDIC.Group, using logon Account
* SYSDIC.Group.Account
* SYSDIC.Group.Account:Node*
* DictionaryName is redirected by a file equation **
where Group and Account specify the location where
System Dictionary is installed.
* NODE specifies a remote computer. See the Discussion
chapter of this intrinsic for information on accessing a
dictionary on a remote system. ** See Discussion, #3.
Scope Required input; type = NameOrNumberType
This parameter specifies the user's scope for the
current dictionary session.
Password Required input; type = ScopePassword
This parameter specifies the password for the user's
scope.
OpenMode Required input by value; type = 4 byte Integer
Specifies one of five modes in which the dictionary may
be opened, and is decoded as follows:
1. = Shared Read access
2. = Shared Update access
3. = Exclusive Update access
4. = Exclusive Customization access
5. = Shared Read-Only access
NameMode Required input by value; type = 4 byte Integer
Selects the use of either internal or external names.
1. = Use internal names
2. = Use external names
Domain Required input; type = NameOrNumberType
Specifies the domain to be used during the current
dictionary session. A blank string or 0 passed for this
parameter will cause the domain to default to the Common
Domain when the dictionary is opened in modes 1, 2, 3,
or 5. Any names or blanks passed when opening the
dictionary in mode 4 will be ignored, as changes to both
occurrences and the dictionary environment are not
allowed in this mode.
Version Required input; type = NameOrNumberType
Specifies the version of the dictionary to be used
during the current dictionary session. No version is
required when the dictionary is opened in mode 4
(Exclusive Customization). When a blank string or 0 is
used, the version to be used will be determined by the
VersionStatus parameter.
VersionStatus Required input by value; type = VersionStatusType
When used, selects the last assigned version in either
Test, production or Archival status. If zero is passed
for this parameter and no version has been specified,
the version status will default to Production.
Numerical values for the version statuses are:
1. = Test status
2. = Production status
3. = Archival status
Dcb Output; type = DcbType
This parameter returns information about the dictionary
to this intrinsic. It will be used in all subsequent
dictionary intrinsic calls. There is one Dcb for each
successful dictionary OPEN, regardless of how many
concurrent access paths (OPENs) there are to the
dictionary.
_______________________________________________________
CAUTION Do not change the Dictionary Control Block in
any way. You may make the Dictionary
unuseable.
_______________________________________________________
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 version number |
| | |
-------------------------------------------------
| | |
| 21 - 24 | Dictionary native language ID |
| | number |
| | |
-------------------------------------------------
Discussion
This intrinsic defines a specific access path to the dictionary. A
description of access paths is located in Chapter 2 of the General
Reference Manual, under the heading "Opening the Dictionary" .
The following restrictions apply when using this intrinsic:
1. Open mode--This intrinsic will succeed in any dictionary open mode
that does not conflict with an open mode in use by another user.
See the table below for restrictions for each open mode.
---------------------------------------------------------------------------
| | |
| Dictionary Open Mode | Restriction(s) |
| | |
---------------------------------------------------------------------------
| | |
| Shared Read mode | Allowed only with Shared Read mode |
| | or Shared Update mode. |
| | |
---------------------------------------------------------------------------
| | |
| Shared Update mode | Allowed only with Shared Read mode |
| | or Shared Update mode. |
| | |
---------------------------------------------------------------------------
| | |
| Exclusive Update mode | Allowed only by itself. |
| | |
---------------------------------------------------------------------------
| | |
| Exclusive Customization mode | Allowed only by itself. |
| | |
---------------------------------------------------------------------------
| | |
| Shared Read-Only mode | Allowed only with Shared Read-Only |
| | mode. |
| | |
---------------------------------------------------------------------------
2. Security--The current scope must be the Dictionary Administrator
scope or a scope with access to the domain specified in the Domain
parameter.
Scope password must agree with scope used.
3. The dictionary name may be any MPE filename. However, because
System Dictionary requires that the name 'SYSDIC' be used, an MPE
file equation from the selected name to 'SYSDIC' should be set up
before attempting to open the dictionary.
4. All dictionary names specified when calling this intrinsic must
exist prior to the call.
5. Either Version or VersionStatus may be specified. Both parameters
cannot be used at the same time.
_________________________________________________________________
CAUTION A different variable for the Dcb parameter is required in
each call to SDOpen, if the dictionary is simultaneously
opened multiple times during a single session.
_________________________________________________________________
Remote Dictionary Access
System Dictionary includes a feature which allows users to access
dictionaries on remote systems, a remote system being any other system
than the one to which you are currently logged on. The uses for this
feature are explained in the HP System Dictionary/XL General Reference
Manual, Volume 1 (32256-90004). The following information explains how
to use this feature via the intrinsic SDOpen.
A remote dictionary is accessed by first establishing a session on a
remote system. For information on system to system communications, refer
to the NS3000/XL User/Programmer Reference Manual (36920-90001) or the
NS3000/XL Network Manager Reference Manual (36920-90002).
RUNNING WITH NS3000
After the remote session has been established, the remote dictionary can
be accessed by including the remote system name in the dictionary name.
For example, when calling SDOpen, the name passed to the dictionary
parameter could take the form:
filename[.group[.account]][:remnode]
where filename could be either SYSDIC or a file equated name which
identifies the dictionary to be accessed. Note that whenever the remote
logon group or account is not the location of the dictionary to be
accessed, the group and account must be supplied either explicitly or
with a file equation.
It is also possible to use a file equation to completely identify the
remote dictionary, as shown in the following example.
FILE RDICT1=SYSDIC.PUB.CORPINFO:REMOTESYS"
where RDICT1 would be passed to the dictionary parameter when calling
SDOpen.
RUNNING WITH DS3000
When either the local or remote system (or both) is a DS3000 node the
above methods of addressing the remote dictionary do not work. Instead,
a file equation containing the device number of the remote node must be
used, as shown in the following example.
* FILE RDICT1=SYSDIC.PUB.CORPINFO;DEV=17#
where 17 is the device number of the remote system, and must be known to
the user.
NOTE The dictionary on the remote system must be compatible with the
System Dictionary software on the local system, i.e. it must be
the same version. If it isn't, the call to SDOpen will fail.
Note also, that as with any subsystem or program being accessed on a
remote system, the performance of System Dictionary is likely to be
slower than when run on a local system.