JAMS Reference Manual
Contents Index JAMS Home Support

JAMS Reference Manual


Previous Contents Index


JAMS_SET_DATA

The JAMS_SET_DATA routine is used to return data to the JAMS_SCHEDULE process.

Format

JAMS_SET_DATA context,


data-ident1, return-desc1,
[data-ident2, data-desc2]...

RETURNS

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

ARGUMENTS

context


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

This is the context variable which was passed to your routine by JAMS. The JAMS_SET_DATA routine can be called only when a context has been established and passed to your code via a JAMS calluser routine.

data-identN


VMS usage: longword
type: longword
access: read only
mechanism: by value

The data-ident parameter identifies a data element which you want to return to the JAMS_SCHEDULE process.

data-descN


VMS usage: various
type: various
access: write only
mechanism: by descriptor

The data-desc parameter is a descriptor which points to the location of the variable which is to be returned to the JAMS_SCHEDULE process.

Description

The JAMS_SET_DATA routine can be called from your JAMS_SCHCALLUSER routine to modify data associated with a job completion. When calling JAMS_SET_DATA you pass one or more pairs of data-ident and data-desc parameters.

The data identifiers supported vary based on the type of calluser context. JAMS can call your code with the following context types:
JAMS_K_SCHSTART JAMS_SCHEDULE process is starting up.
JAMS_K_SCHSTOP JAMS_SCHEDULE process is stopping.
JAMS_K_JOBSTART A Job is starting to execute.
JAMS_K_JOBEND A Job has completed.

The following data identifiers are supported by the JAMS_SET_DATA routine when the context type is JAMS_K_JOBEND:

JAMS_K_FINAL_STATUS

Allows you to change the final status of a job. You could, for example, scan a job's .LOG file for a specific string and change a good status to a bad status if the string was found. The data descriptor must point to an integer variable.

JAMS_K_MAIL_ADR

Allows you to change the list of VMS mail addresses which will be notified if this Job ended with a bad status. The list of addresses may be up to 256 characters in length. The data descriptor must point to a character string variable.

JAMS_K_OPER_CLASSES

Allows you to change the list of VMS OPCOM operator classes which will receive an OPCOM message if this Job ended with a bad status. The list of classes may be up to 256 characters in length. The data descriptor must point to a character string variable.

JAMS_K_REPLY_USERS

Allows you to change the list of VMS username which will receive a broadcast message if this Job ended with a bad status. The list of usernames may be up to 256 characters in length. The data descriptor must point to a character string variable.


Return Values

JAMS_INVCTX Invalid context passed in.
JAMS_INVDATAID Invalid data identifier.
JAMS_INVRETDSC Invalid data descriptor.


Previous Next Contents Index
JAMS Copyright © 2000, MVP Systems, Inc. All rights reserved.