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

$$NAME^XUSER(): Get Name of User

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

Description

The $$NAME^XUSER extrinsic function returns the full name of the specified user in a mixed case displayable format. The user's given name (i.e., First Last) is returned unless a second parameter of F is passed in to get the Family name (i.e., Last,First).

Format

  $$NAME^XUSER(ien[,format])

Input Parameters

ien:

(required) Internal Entry Number (IEN) of the provider to be checked in the NEW PERSON (#200) file.
format:

(optional) This parameter indicates if the user's name should be returned formatted by Family or Given name, respectively. Possible values are:

  • F—Family (e.g., "Xuuser,Two").

  • G (default)—Given (e.g., "Two Xuuser").

Output

returns:

Returns user's family or given name.

 

Examples

Example 1

Retrieving the user name in Given format:

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

>W X
Two E Xuuser

Example 2

Retrieving the user name in Family format:

>S X=$$NAME^XUSER(1529,"F")

>W X
Xuuser,Two E.