SysWorks
Callable Routines Reference Manual
SWRK_CVT_CONTEXT_DESCRIPTION
The SWRK_CVT_CONTEXT_DESCRIPTION routine ...
Format
status =SWRK_CVT_CONTEXT_DESCRIPTION(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_CVT_CONTEXT_DESCRIPTION routine ...
See also
SWRK_CVT_CONTEXT_TYPE
The SWRK_CVT_CONTEXT_TYPE routine ...
Format
status =SWRK_CVT_CONTEXT_TYPE(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_CVT_CONTEXT_TYPE routine ...
See also
SWRK_CVT_INDEX_TO_STRING
The SWRK_CVT_INDEX_TO_STRING routine ...
Format
status =SWRK_CVT_INDEX_TO_STRING(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_CVT_INDEX_TO_STRING routine ...
See also
SWRK_CVT_LNKLST_TO_STRING
The SWRK_CVT_LNKLST_TO_STRING routine ...
Format
status =SWRK_CVT_LNKLST_TO_STRING(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_CVT_LNKLST_TO_STRING routine ...
See also
SWRK_CVT_SCOPE_TYPE_TO_CODE
The SWRK_CVT_SCOPE_TYPE_TO_CODE routine ...
Format
status =SWRK_CVT_SCOPE_TYPE_TO_CODE(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_CVT_SCOPE_TYPE_TO_CODE routine ...
See also
SWRK_CVT_SCOPE_TYPE_TO_CTL
The SWRK_CVT_SCOPE_TYPE_TO_CTL routine ...
Format
status =SWRK_CVT_SCOPE_TYPE_TO_CTL(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_CVT_SCOPE_TYPE_TO_CTL routine ...
See also
SWRK_CVT_TRACE_DESCRIPTION
The SWRK_CVT_TRACE_DESCRIPTION routine ...
Format
status =SWRK_CVT_TRACE_DESCRIPTION(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_CVT_TRACE_DESCRIPTION routine ...
See also
SWRK_DCL_HANDLER
The DCL Interface Handler routine initializes a DCL utility in either
single command or multi command mode. In single command mode the
command present on the command line is parsed and executed. In multi
line mode, the utility is passed no command line and prompts the user
for a number of commands until an EXIT command is used.
Format
status =SWRK_DCL_HANDLER (tables, utlnam, [prompt], [ctlflg],
[cmdlin])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
tables
|
VMS usage:
|
command_tables
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies the address of the DCL command tables. Generally this is the
value associated with the name of the Command Definition Utility module.
utlnam
|
VMS usage:
|
char_string
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies the name of the utility. This name is used to lookup the
first level of help (when SWRKDCL_HELP
is used), and to be part of the default prompt used when the
prompt argument is not used.
prompt
|
VMS usage:
|
char_string
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies the prompt to be used in multi line mode or when extra input
is required. By default, the utility name specified in
utlnam with a "> " appended is used. When more
input is required, a leading underscore is used.
ctlflg
|
VMS usage:
|
flags
|
|
type:
|
longword (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Flags specifying options for the SWRK_DCL_HANDLER operation. The
ctlflg argument is a longword bit mask that is the
logical OR of each bit set, where each bit corresponds to an option.
The $DUIDEF macro defines a symbolic name for each flag bit. The
following table describes each flag.
| Flag |
Description |
|
DUI_M_SMG_INPUT
|
When this flag is specified, SMG$ routines are used to manage input,
otherwise direct RMS calls are used. Using this feature allows use of a
recall buffer.
|
|
DUI_M_SMG_OUTPUT
|
When this flag is specified, SMG$ routines are used to manage output,
otherwise direct RMS calls are used. Using this feature allows
advantage to be taken of using a video terminal with help etc.
|
|
DUI_M_TPU
|
When this flag is specified, TPU routines are used for input and output.
|
|
DUI_M_QUOTE_PLUS
|
When this flag is specified, quotation marks are placed around
qualifier values containing a plus signs. This is useful for providing
a front end for CMS.
|
cmdlin
|
VMS usage:
|
char_string
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies a command line to be parsed and executed in place of the DCL
command line.
Description
The SWRK_DCL_HANDLER routine provides a standard interface for a DCL
utility.
See also
SWRKDCL_EXIT
SWRKDCL_HELP
SWRK_DEALLOCATE_BITS
The SWRK_DEALLOCATE_BITS routine ...
Format
status =SWRK_DEALLOCATE_BITS(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_DEALLOCATE_BITS routine ...
See also
SWRK_DEALLOCATE_MEMORY
The SWRK_DEALLOCATE_MEMORY routine ...
Format
status =SWRK_DEALLOCATE_MEMORY(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_DEALLOCATE_MEMORY routine ...
See also
SWRK_DECLARE_BITMAP
The SWRK_DECLARE_BITMAP routine ...
Format
status =SWRK_DECLARE_BITMAP(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_DECLARE_BITMAP routine ...
See also
SWRK_DECLARE_CLIENT
The SWRK_DECLARE_CLIENT routine ...
Format
status =SWRK_DECLARE_CLIENT(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_DECLARE_CLIENT routine ...
See also
SWRK_DECLARE_COUNTER
The SWRK_DECLARE_COUNTER routine ...
Format
status =SWRK_DECLARE_COUNTER(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_DECLARE_COUNTER routine ...
See also
SWRK_DECLARE_SERVER
The SWRK_DECLARE_SERVER routine ...
Format
status =SWRK_DECLARE_SERVER(arg1, [arg2])
RETURNS
|
VMS usage:
|
cond_value
|
|
type:
|
integer (unsigned)
|
|
access:
|
write only
|
|
mechanism:
|
by value in R0
|
Arguments
arg1
|
VMS usage:
|
arg1_type
|
|
type:
|
integer (unsigned)
|
|
access:
|
read only
|
|
mechanism:
|
by reference
|
Specifies arg1...
arg2
|
VMS usage:
|
arg2_type
|
|
type:
|
character string
|
|
access:
|
read only
|
|
mechanism:
|
by descriptor
|
Specifies arg2...
Description
The SWRK_DECLARE_SERVER routine ...
See also