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

$$ACTIVE^XUSER(): Status Indicator

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

Description

The $$ACTIVE^XUSER extrinsic function returns the active status indicator and latest signon information of a user in the NEW PERSON (#200) file.

Format

  $$ACTIVE^XUSER(ien)

Input Parameters

ien:

(Required) Internal Entry Number (IEN) of the user to be checked in the NEW PERSON (#200) file.

Output

returns:

Returns any of the following codes:

  • ""—NULL, no user record found.

  • 0—User cannot sign on.

  • 0^DISUSER—User cannot sign on because of DISUSER flag.

  • 0^TERMINATED^FMDATE—User terminated on date indicated.

  • 1^NEW—A new user, can sign on.

  • 1^ACTIVE^FMDATE—An active user, last signon date.

Examples

Example 1

This is an example of an Active User in the NEW PERSON (#200) file:

>S X=$$ACTIVE^XUSER(1529)

>WRITE X
1^ACTIVE^3030321.093756

Example 2

This is an example of a Terminated User in the NEW PERSON (#200) file:

>S X=$$ACTIVE^XUSER(957)

>W X
0^TERMINATED^2980504

Example 3

This is an example of a User with no record in the NEW PERSON (#200) file, returns a NULL string:

>S X=$$ACTIVE^XUSER(999999999)
  
>W X

>

Example 4

This is an example of a User in the NEW PERSON (#200) file with the DISUSER flag set:

>S X=$$ACTIVE^XUSER(111)
  
>W X
0^DISUSER