Kernel APIs: DIV4^XUSER

DIV4^XUSER(): Get User Divisions

Reference Type: Controlled Subscription, Category: User, Integration Agreement: 2533

Description

This API returns all divisions for a user. It returns:

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

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 file (#200). 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 file (#200). It indicates that the array of pointers to the Institution file has been defined.

The array includes all IENs for the INSTITUTION file (#4) 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 file (#200) entry. The format is:
ARRAY([^DIC(4 IEN])
0—The array of pointers to the NSTITUTION file (#4) has not been defined.

Example

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

VA (Internet) / VA (Intranet) / OI / HSD&D / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: November 15, 2006

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.