DSSetUserStatus

Use the DSSetUserStatus routine to set a termination code for interrogation by another job. This routine applies only to the current job, and does not take a JobHandle parameter.

This routine can be used by any job in either a JobControl or After routine to set a termination code for interrogation by another job. In fact, the code might be set at any point in the job, and the last setting is the one that will be picked up at any time. So to be certain of getting the actual termination code for a job the caller should use DSWaitForJob and DSGetJobInfo first, checking for a successful finishing status.

This routine is defined as a subroutine not a function because there are no possible errors.

Syntax


Call DSSetUserStatus (UserStatus)

UserStatus String is any user-defined termination message. The string will be logged as part of a suitable "Control" event in the calling job's log, and stored for retrieval by DSGetJobInfo, overwriting any previous stored string.

This string should not be a negative integer, otherwise it might be indistinguishable from an internal error in DSGetJobInfo calls.

Example

The following command sets a termination code of "sales job done":


Call DSSetUserStatus("sales job done")