| Previous | Contents | Index |
The SWRK_PURGE_FILE routine ...
status =SWRK_PURGE_FILE( file-spec [,dflt-file-spec] [,rltd-file-spec] [,keep] [,user-success-clb] [,user-error-clb] [,user-confirm-clb] [,user-arg] [,rslt-file-spec] [,context] [,extended-flags] [,ufsa-type] [,log-flags])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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 purged. 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 purged. 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 purged. 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 purged. 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.
keep
VMS usage: integer type: longword (unsigned) access: read only mechanism: by reference
Specifies the maximum number of versions of the specified files to be retained in the directory. If you do not include this argument of the suppied value is zero, all but the highest numbered version of the specified files are deleted from the directory.
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 purged.
The success routine can be used to display a log of the files that were purged.
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 purged.
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 purged. The value returned by the confirm routine determines whether or not the file will be purged. The confirm routine can be used to select specific files for purge 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:
- Of the same class as the descriptor required by the filespec argument of any action routines. 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.
- (Alpha only) Of the same form as the descriptor required by the filespec argument of all action routines. For example, if the filespec argument of an action routine uses a 64-bit descriptor, then the rslt-file-spec argument must also use a 64-bit descriptor.
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.
The SWRK_PURGE_FILE routine ...
The SWRK_PUT_OUTPUT_FAOZ routine ...
status =SWRK_PUT_OUTPUT_FAOZ(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_PUT_OUTPUT_FAOZ routine ...
The SWRK_PUT_OUTPUT_FAO routine ...
status =SWRK_PUT_OUTPUT_FAO(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_PUT_OUTPUT_FAO routine ...
The SWRK_PUT_OUTPUT_PRINTF routine ...
status =SWRK_PUT_OUTPUT_PRINTF(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_PUT_OUTPUT_PRINTF routine ...
The SWRK_PUT_OUTPUT routine ...
status =SWRK_PUT_OUTPUT(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_PUT_OUTPUT routine ...
The SWRK_PUT_RECORD routine ...
status =SWRK_PUT_RECORD(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_PUT_RECORD routine ...
The SWRK_RANDOM_NUMBER routine ...
status =SWRK_RANDOM_NUMBER(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_RANDOM_NUMBER routine ...
The SWRK_READ_SERVER_MSG_ITMLST routine ...
status =SWRK_READ_SERVER_MSG_ITMLST(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_READ_SERVER_MSG_ITMLST routine ...
The SWRK_READ_SERVER_MSG_RECORD routine ...
status =SWRK_READ_SERVER_MSG_RECORD(arg1, [arg2])
VMS usage: cond_value type: integer (unsigned) access: write only mechanism: by value in R0
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...
The SWRK_READ_SERVER_MSG_RECORD routine ...
| Previous | Next | Contents | Index |