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

$$KCHK^XUSRB(): Check If User Holds Security Key

Reference Type: Controlled Subscription, Category: User, ICR#: 2120

Description

The $$KCHK^XUSRB extrinsic function checks to see if a user holds a given security key.

Format

  $$KCHK^XUSRB(key[,ien])

Input Parameters

key:

(required) The name of the security key to be checked.
ien:

(optional) Internal Entry Number (IEN). It defaults to DUZ.

Output

returns:

Returns:

  • 1—User holds security key.

  • 0—User does not hold security key.

Examples

Example 1

The following example illustrates the results when a user holds a security key input:

>S X=$$KCHK^XUSRB("XUPROGMODE")

>W X
1

Example 2

The following example illustrates the results when a user does not hold the security key input:

>S X=$$KCHK^XUSRB("XUMGR")

>W X
0

Example 3

The following example illustrates the results when checking if another user holds a security key input by including their IEN:

>S X=$$KCHK^XUSRB("XUPROGMODE",30)

>W X
1