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

$$LEGACY^XUAF4(): Institution Realigned/Legacy (True/False)

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

Description

The $$LEGACY^XUAF4 extrinsic function, given the STATION NUMBER (#99) field in the INSTITUTION (#4) file, returns the Boolean value for the question—has this station number been realigned? Is it a legacy Station Number?

Format

  $$LEGACY^XUAF4(sta)

Input Parameters

sta:

(required) The STATION NUMBER (#99) field value in the INSTITUTION (#4) file for the Station Number in question.

Output

returns:

Returns a Boolean value:

  • True (non-zero)—Station Number has been realigned; it is a legacy Station Number.

  • False (zero)—Station Number has not been realigned; it is not a legacy Station Number.