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

DIV4^XUSER(): Get User Divisions

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

Description

The DIV4^XUSER API returns all divisions for a user. It returns:

Format

  DIV4^XUSER(.array[,duz])

Input Parameters

.array:

(required) This parameter is a local variable (i.e., array name) passed by reference.
duz:

(optional) The Internal Entry Number (IEN) of the user in the NEW PERSON (#200) file. If DUZ is not passed as a parameter, the function defaults to the value of DUZ in the application's partition.

Output Parameters

.array:

Returns:

  • 1—If the user has a Division entry in the NEW PERSON (#200) file. It indicates that the array of pointers to the Institution file has been defined.

    The array includes all IENs for the INSTITUTION (#4) file that have been assigned to the user.

    The array is defined and left in the application's partition, if the user indicated by the value of the duz input parameter has divisions defined in the respective NEW PERSON (#200) file entry. The format is:
    ARRAY([^DIC(4 IEN])
  • 0—The array of pointers to the INSTITUTION (#4) file has not been defined.

Example

>S X=$$DIV4^XUSER(.ZZ,duz)