SysWorks©

SysWorks
Callable Routines Reference Manual


Previous Contents Index

Longword of flag bits designating extended behavior. The flags argument is the address of an unsigned longword containing the flag bits. This is an optional argument; if omitted, the default is that all flags are clear.

Flag Usage
BINARY Force binary file types into binary file format.
CONFIRM A confirmation is required before any action is performed on a file.
COPY .
DELETE .
IGNORE_DIRECTORIES .
HEADER .
MULTIPLE .
NOSEARCHLIST .
NO_RLF .
PRT .
QUALIFIED The extended file search qualifiers are to be used.
RETAIN_CDT .
RETAIN_RDT .
RECORD Use record mode rather than block mode.
SEQUENTIAL .
UPDATE Open files with update allowed.

The flag values have symbolic names of the form UFSA$M_flag and UFSA$V_flag.

ufsa-type


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

Specifies the structure of the source file specification.

The following table lists the types of file specification argument which can be passed.
Type Structure
INDEX A binary index passed by reference (not implemented yet).
LNKLST Linked list of strings passed by reference.
STRING String passed by descriptor.

The type values have a symbolic name of the form UFSA$C_type.

By default, STRING is assumed.

log-flags


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

Longword of flag bits designating logging behavior. The flags argument is the address of an unsigned longword containing the flag bits. This is an optional argument; if omitted, the default is that all flags are clear.


Description

The SWRK_MANAGE_FILE routine ...

See also


SWRK_MATCH_LNKLST

The SWRK_MATCH_LNKLST routine ...


Format

status =SWRK_MATCH_LNKLST(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_MATCH_LNKLST routine ...

See also


SWRK_MATCH_STRING

The SWRK_MATCH_STRING routine ...


Format

status =SWRK_MATCH_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_MATCH_STRING routine ...

See also


SWRK_MOVE_FILE

The SWRK_MOVE_FILE routine ...


Format

status =SWRK_MOVE_FILE( old-file-spec, new-file-spec [,dflt-file-spec] [,rltd-file-spec] [,flags] [,user-success-clb] [,user-error-clb] [,user-confirm-clb] [,user-arg] [,old-rslt-file-spec] [,new-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

old-file-spec


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

File specification of the files to be moved. The old-file-spec argument is the address of a descriptor pointing to the old file specification. The specification may include wildcards, in which case each file that matches the specification will be moved. The string must not contain more than 255 characters. Any string class is supported.

new-file-spec


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

File specification for the new file names. The new-file-spec argument is the address of a descriptor pointing to the new file specification.

This specification need not be complete; fields omitted or specified by using the wildcard character (*) will be filled in from the existing file's name using the same rules as for the equivalent DCL command. The string must not contain more than 255 characters. Any string class is supported.

dflt-file-spec


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

Default file specification of the files to be moved. 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 moved. 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.

flags


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

Longword of flag bits designating optional behavior. The flags argument is the address of an unsigned longword containing the flag bits. This is an optional argument; if omitted, the default is that all flags are clear.

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 moved.

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

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 moved.

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 moved. The value returned by the confirm routine determines whether or not the file will be moved. The confirm routine can be used to select specific files for moving 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.

old-rslt-file-spec


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

String into which the old resultant file specification of the last file processed is copied. This is an optional argument. If present, it is used to store the file specification passed to the user supplied routines instead of a default class S, type T string. Any string class is supported.

If you are specifying one or more of the action routine arguments, be sure that the descriptor class used to pass the resultant name is the same as the descriptor class required by the action routine. For example, VAX Ada requires a class SB descriptor for string arguments to Ada routines, but will use a class A descriptor by default when calling external routines.

Refer to your language manual to determine the proper descriptor class to use.

new-rslt-file-spec


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

String into which new OpenVMS RMS resultant file specification of the last file processed is written. The new-rslt-file-spec argument is the address of a descriptor pointing to the new name. This is an optional argument. If present, it is used to store the file specification passed to the user supplied routines instead of a class S, type T string. Any string class is supported.

If you are specifying one or more of the action routine arguments, be sure that the descriptor class used to pass the resultant name is the same as the descriptor class required by the action routine. For example, VAX Ada requires a class SB descriptor for string arguments to Ada routines, but will use a class A descriptor by default when calling external routines. Refer to your language manual to determine the proper descriptor class to use.

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

Longword of flag bits designating extended behavior. The flags argument is the address of an unsigned longword containing the flag bits. This is an optional argument; if omitted, the default is that all flags are clear.

Flag Usage
BINARY Force binary file types into binary file format.
CONFIRM A confirmation is required before any action is performed on a file.
COPY .
DELETE .
IGNORE_DIRECTORIES .
HEADER .
MULTIPLE .
NOSEARCHLIST .
NO_RLF .
PRT .
QUALIFIED The extended file search qualifiers are to be used.
RETAIN_CDT .
RETAIN_RDT .
RECORD Use record mode rather than block mode.
SEQUENTIAL .
UPDATE Open files with update allowed.

The flag values have symbolic names of the form UFSA$M_flag and UFSA$V_flag.

ufsa-type


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

Specifies the structure of the source file specification.

The following table lists the types of file specification argument which can be passed.
Type Structure
INDEX A binary index passed by reference (not implemented yet).
LNKLST Linked list of strings passed by reference.
STRING String passed by descriptor.

The type values have a symbolic name of the form UFSA$C_type.

By default, STRING is assumed.

log-flags


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

Longword of flag bits designating logging behavior. The flags argument is the address of an unsigned longword containing the flag bits. This is an optional argument; if omitted, the default is that all flags are clear.


Description

The SWRK_MOVE_FILE routine ...

See also


SWRK_OPEN_FILE

The SWRK_OPEN_FILE routine ...


Format

status =SWRK_OPEN_FILE(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_OPEN_FILE routine ...

See also


SWRK_OPEN_INPUT

The SWRK_OPEN_INPUT routine ...


Format

status =SWRK_OPEN_INPUT(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_OPEN_INPUT routine ...

See also


Previous Next Contents Index