Kernel 8.0 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

$$DTIME^XUP(): Reset DTIME for USER

Reference Type: Supported, Category: User, Integration Agreement: 4409

Description

This extrinsic function resets the DTIME variable for the user identified by the first parameter "DUZ" of this function. This extrinsic function accepts two parameters:

  1. IEN or DUZ of the user in the NEW PERSON file (#200).

  2. IEN of the device in the DEVICE file (#3.5).

The return value should be assigned to the variable DTIME as shown in the examples. This DTIME variable is used on all timed READS where interactive responses are required for a given user.

Format

  $$DTIME^XUP([duz][,ios])

Input Parameters

duz:

(optional) The Internal Entry Number (IEN) or DUZ of the user in the NEW PERSON file (#200).

ios:

(optional) The IEN of the device in the DEVICE file (#3.5). This IEN should be the same value of IOS if present, and should reflect the current sign-on device of the user.

Output

returns:

The return value will be based on the first available data found in the following fields/files (listed in search order):

1

TIMED READ (# OF SECONDS) field (#200.1) of the NEW PERSON file (#200).

2

TIMED READ (# OF SECONDS) field (#51.1) of the DEVICE file (#3.5).

3

DEFAULT TIMED READ (SECONDS) field (#210) of the KERNEL SYSTEM PARAMETERS file (#8989.3).

4

(default) If no data is available in any of the three fields above, then the return value defaults to 300 seconds.

Example 1

Sending DUZ only, returns the value in Field #200.1, TIMED READ (# OF SECONDS), of the NEW PERSON file (#200):

>S DTIME=$$DTIME^XUP(DUZ)

>W DTIME
1800

Example 2

Sending DUZ and IOS, returns the value in Field #200.1, TIMED READ (# OF SECONDS), of the NEW PERSON file (#200):

>S DTIME=$$DTIME^XUP(DUZ,IOS)

>W DTIME
1800

Example 3

Sending IOS only, returns the value in Field #51.1, TIMED READ (# OF SECONDS), of the DEVICE file (#3.5):

>S DTIME=$$DTIME^XUP(,IOS)

>W DTIME
500

Example 4

Not Sending DUZ or IOS, returns the value in Field #210, DEFAULT TIMED READ (SECONDS), of the KERNEL SYSTEM PARAMETERS file (#8989.3):

>S DTIME=$$DTIME^XUP(,)

>W DTIME
400

Or

>S DTIME=$$DTIME^XUP()

>W DTIME
400

Example 5

Not Sending DUZ or IOS and no value is in Field #210, DEFAULT TIMED READ (SECONDS), of the KERNEL SYSTEM PARAMETERS file (#8989.3):

>S DTIME=$$DTIME^XUP()

>W DTIME
300


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: September 15, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.