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

USERINFO^XUSRB2(): Get Demographics for Current User

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

Description

The USERINFO^XUSRB2 API retrieves various user demographic information for the current user.

NOTE: This was developed as a Broker/VistALink RPC and all RPCs have as the first parameter the return/output parameter.

Format

  USERINFO^XUSRB2(ret)

Input Parameters

ret:

(required) Name of the subscripted return array. In every API that is used as an RPC, the first parameter is the return array.

Output Parameters

ret():

Returns a subscripted output array:

  • RET(1)—User's name from the .01 field of the NEW PERSON (#200) file.

  • RET(2)—Concatenated user name from the NAME COMPONENTS (#20) file.

  • RET(3)—Logged on division:
      ien^name^number
  • RET(4)—User's title from the NEW PERSON (#200) file.

  • RET(5)—User's service section from NEW PERSON (#200) file (external format).

  • RET(6)—User's language from the NEW PERSON (#200) file.

  • RET(7)—User's timeout.