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

$$ACTIVE^XUAF4(): Institution Active Facility (True/False)

Reference Type: Supported, Category: Institution File, ICR#: 2171

Description

The $$ACTIVE^XUAF4 extrinsic function, given the Internal Entry Number (IEN) in the INSTITUTION (#4) file, returns the Boolean value for the question-is this an active facility? It checks to see if the INACTIVE FACILITY FLAG (#101) field is not set.

Format

  $$ACTIVE^XUAF4(ien)

Input Parameters

ien:

(required) Internal Entry Number (IEN) of the institution in question.

Output

returns:

Returns a Boolean value:

  • True (non-zero)—Station Number is an active facility.

  • False (zero)—Station Number is not an active facility. The INACTIVE FACILITY FLAG (#101) field has a value indicating it is inactive.