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

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

Reference Type: Supported, Category: User, ICR#: 4409

Description

The $$DTIME^XUP extrinsic function resets the DTIME variable for the user identified by the duz input parameter. This extrinsic function accepts two parameters:

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

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

The return value should be assigned to the DTIME variable 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 (#200) file.
ios:

(optional) The IEN of the device in the DEVICE (#3.5) file. 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 is based on the first available data found in the following fields/files (listed in search order):

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

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

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

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

 

Examples

Example 1

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

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

>W DTIME
1800

Example 2

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

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

>W DTIME
1800

Example 3

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

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

>W DTIME
500

Example 4

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

>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 DEFAULT TIMED READ (SECONDS) (#210) field in the KERNEL SYSTEM PARAMETERS (#8989.3) file:

>S DTIME=$$DTIME^XUP()

>W DTIME
300