SysWorks©

SysWorks
Callable Routines Reference Manual


Previous Contents Index


SWRK_LOG_RDB_NO_TRANS

The SWRK_LOG_RDB_NO_TRANS routine ...


Format

status =SWRK_LOG_RDB_NO_TRANS(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_LOG_RDB_NO_TRANS routine ...

See also


SWRK_LOG_RDB

The SWRK_LOG_RDB routine ...


Format

status =SWRK_LOG_RDB(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_LOG_RDB routine ...

See also


SWRK_LOG_RDB_SETUP_2

The SWRK_LOG_RDB_SETUP_2 routine ...


Format

status =SWRK_LOG_RDB_SETUP_2(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_LOG_RDB_SETUP_2 routine ...

See also


SWRK_LOG_RDB_SETUP

The SWRK_LOG_RDB_SETUP routine ...


Format

status =SWRK_LOG_RDB_SETUP(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_LOG_RDB_SETUP routine ...

See also


SWRK_LOG_RMS_FAB_2

The SWRK_LOG_RMS_FAB_2 routine ...


Format

status =SWRK_LOG_RMS_FAB_2(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_LOG_RMS_FAB_2 routine ...

See also


SWRK_LOG_RMS_FAB

The SWRK_LOG_RMS_FAB routine ...


Format

status =SWRK_LOG_RMS_FAB(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_LOG_RMS_FAB routine ...

See also


SWRK_LOG_RMS_FILE_STS

The SWRK_LOG_RMS_FILE_STS routine ...


Format

status =SWRK_LOG_RMS_FILE_STS(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_LOG_RMS_FILE_STS routine ...

See also


SWRK_LOG_RMS_RAB

The SWRK_LOG_RMS_RAB routine ...


Format

status =SWRK_LOG_RMS_RAB(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_LOG_RMS_RAB routine ...

See also


SWRK_LOG_STATUS

This routine logs a message which is passed as an OpenVMS status with optional arguments.


Format

status =SWRK_LOG_STATUS (flags, source_file, source_reference, status [, value...])


RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

See SWRK_LOG_MSG_VEC for more details about the first three arguments.


Arguments

flags


VMS usage: flags
type: longword (unsigned)
access: read only
mechanism: by value

Specifies which logging actions the routine should take.

source_file


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Specifies the source from which the message is being logged.

source_reference


VMS usage: number
type: longword (unsigned)
access: read only
mechanism: by value

Specifies a reference number within the source.

status


VMS usage: cond_value
type: longword (unsigned)
access: read only
mechanism: by value

Specifies the OpenVMS message id of the message to be logged. See the $GETMSG system service for more details.

values


VMS usage: varying_arg
type: longword (signed)
access: read only
mechanism: by value

Specifies optional expressions whose resultant types correspond to conversion specifications given in the OpenVMS message text.

If no conversion specifications are given, you may omit the output sources. Otherwise, the function call must have exactly as many output sources as there are conversion spec- ifications, and the conversion specifications must match the types of the output sources.

Conversion specifications are matched to output sources in left-to-right order. Excess output pointers, if any, are ignored.


Description

This routine logs the formatted message specified by the status and value arguments to appropriate log files. It is similar to a call to SWRK_SETUP_MSG_VEC followed by a call to SWRK_LOG_MSG_VEC.

See also

SWRK_LOG_MSG_VEC
SWRK_SETUP_MSG_VEC

SWRK_LOG_TEXT

This routine logs a message which is passed as simple text string.


Format

status =SWRK_LOG_TEXT (flags, source_file, source_reference, message_text)


RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

See SWRK_LOG_MSG_VEC for more details about the first three arguments.


Arguments

flags


VMS usage: flags
type: longword (unsigned)
access: read only
mechanism: by value

Specifies which logging actions the routine should take.

source_file


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Specifies the source from which the message is being logged.

source_reference


VMS usage: number
type: longword (unsigned)
access: read only
mechanism: by value

Specifies a reference number within the source.

message_text


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Specifies the message to be logged.


Description

This routine logs the message specified by the text message argument to appropriate log files.

See also

SWRK_LOG_MSG_VEC

SWRK_LOOKUP_INDEX

The SWRK_LOOKUP_INDEX routine searches an index for a specific key.


Format

status =SWRK_LOOKUP_INDEX(index_root, key, element )


RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

index_root


VMS usage: structure
type: INDEX_ROOT structure
access: modify
mechanism: by reference

Specifies the address of the index root in which to search for an index element with the specified key.

key


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Specifies the address of the key string descriptor.

new_element


VMS usage: address
type: address
access: write only
mechanism: by reference

Specifies the address of a pointer which receives the address of the found index element.


Description

The SWRK_LOOKUP_INDEX routine searches an index for an index element with the specified key.

See also


SWRK_MANAGE_FILE

The SWRK_MANAGE_FILE routine ...


Format

status =SWRK_MANAGE_FILE( file-spec [,dflt-file-spec] [,rltd-file-spec] [,user-success-clb] [,user-error-clb] [,user-confirm-clb] [,user-arg] [,rslt-file-spec] [,context] [,extended-flags] [,ufsa-type] [,log-flags])


RETURNS

VMS usage: cond_value
type: integer (unsigned)
access: write only
mechanism: by value in R0

Arguments

file-spec


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

String containing the OpenVMS Record Management Services (RMS) file specification of the files to be managed. The file-spec argument is the address of a descriptor pointing to the file specification. If the specification includes wildcards, each file that matches the specification is managed. The string must not contain more than 255 characters. Any string class is supported.

On Alpha systems, set the LIB$M_FIL_LONG_NAMES bit in the flags argument for strings longer than 255 characters in length.

dflt-file-spec


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Default file specification of the files to be managed. The dflt-file-spec argument is the address of a descriptor pointing to the default file specification. This is an optional argument; if the argument is omitted, the default is the null string. Any string class is supported.

See the OpenVMS Record Management Services Reference Manual for information about default file specifications.

rltd-file-spec


VMS usage: char_string
type: character string
access: read only
mechanism: by descriptor

Related file specification of the files to be managed. The rltd-file-spec argument is the address of a descriptor pointing to the related file specification. Any string class is supported. This is an optional argument; if the argument is omitted, the default is the null string.

Input file parsing is used. See the OpenVMS Record Management Services Reference Manual for information on related file specifications and input file parsing.

The related file specification is useful when you are processing lists of file specifications. Unspecified portions of the file specification are inherited from the last file processed.

user-success-clb


VMS usage: procedure
type: procedure value
access: function call (before return)
mechanism: by value

User supplied success routine that is called after a file is successfully managed.

The success routine can be used to display a log of the files that were managed.

user-error-clb


VMS usage: procedure
type: procedure value
access: function call (before return)
mechanism: by value

User supplied error routine that is called when an error is detected.

The error routine returns a success/fail value that is used to determine if more files should be managed.

user-confirm-clb


VMS usage: procedure
type: procedure value
access: function call (before return)
mechanism: by value

User supplied confirm routine that is called before each file is managed. The value returned by the confirm routine determines whether or not the file will be managed. The confirm routine can be used to select specific files for management based on criteria such as expiration date, size, and so on.

user-arg


VMS usage: user_arg
type: longword (unsigned)
access: read only
mechanism: by value

User supplied argument that is passed to the error, success, and confirm routines each time they are called. Whatever mechanism is used to pass user-arg is also used to pass it to the routines. This is an optional argument; if the argument is omitted, zero is passed by value.

rslt-file-spec


VMS usage: char_string
type: character string
access: write only
mechanism: by descriptor

String into which the RMS resultant file specification of the last file processed is written. The rslt-file-spec argument is the address of a descriptor pointing to the resultant name.

If present, rslt-file-spec is used to store the file specification passed to the user supplied routines, instead of a default class S, type T string. Therefore, this argument should be specified when the user supplied routines are used and those routines require a descriptor type other than class S, type T. Any string class is supported.

If you specify one or more of the user supplied action routines, the descriptor used to pass rslt-file-spec must be:

context


VMS usage: context
type: longword (unsigned)
access: modify
mechanism: by reference

A longword integer variable into which the routine stores a context value for use by future calls. The context argument is an unsigned longword integer containing the address of the context. This variable must be set to zero before the first call. You can use the same context argument from one call to another. This argument is used to retain the context when processing multiple input files. Portions of file specifications that the user does not specify may be inherited from the last files processed because the file contexts are retained in this argument. You must not change the value of context in subsequent calls.

extended-flags


VMS usage: mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference


Previous Next Contents Index