| Previous | Contents | Index |
The SWRK_SET_SYMBOL_STRING routine ...
status =SWRK_SET_SYMBOL_STRING(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_SET_SYMBOL_STRING routine ...
The SWRK_SET_TIMER_LONG routine ...
status =SWRK_SET_TIMER_LONG(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_SET_TIMER_LONG routine ...
The SWRK_SET_TIMER routine ...
status =SWRK_SET_TIMER(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_SET_TIMER routine ...
The SWRK_SET_TIMER_SHORT routine ...
status =SWRK_SET_TIMER_SHORT(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_SET_TIMER_SHORT routine ...
The SWRK_SET_UIC routine ...
status =SWRK_SET_UIC(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_SET_UIC routine ...
The SWRK_SET_USERNAME routine ...
status =SWRK_SET_USERNAME(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_SET_USERNAME routine ...
The SWRK_START_SERVER routine ...
status =SWRK_START_SERVER(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_START_SERVER routine ...
The SWRK_START_STATISTIC routine ...
status =SWRK_START_STATISTIC(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_START_STATISTIC routine ...
The SWRK_STOP_SERVER routine ...
status =SWRK_STOP_SERVER(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_STOP_SERVER routine ...
The SWRK_STOP_STATISTIC routine ...
status =SWRK_STOP_STATISTIC(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_STOP_STATISTIC routine ...
The SWRK_STRIP_OBJECT routine ...
status =SWRK_STRIP_OBJECT(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_STRIP_OBJECT routine ...
The SWRK_SUBMIT_BATCH_JOB_CONTEXT routine ...
status =SWRK_SUBMIT_BATCH_JOB_CONTEXT(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_SUBMIT_BATCH_JOB_CONTEXT routine ...
The SWRK_SUSPEND_SERVER routine ...
status =SWRK_SUSPEND_SERVER(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_SUSPEND_SERVER routine ...
The SWRK_TOUCH_FILE routine ... _[element-or-template]...
status =SWRK_TOUCH_FILE( file-spec [,dflt-file-spec] [,rltd-file-spec] [,create-flag] [,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 touched. 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 touched. 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 touched. 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 touched. 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.
create-flag
VMS usage: flag type: longword (unsigned) access: read only mechanism: by reference
Specifies whether the file is created if not already present.
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 touched.
The success routine can be used to display a log of the files that were touched.
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 touched.
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 touched. The value returned by the confirm routine determines whether or not the file will be touched. The confirm routine can be used to select specific files for touching 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
Previous Next Contents Index