 Main Index |
 TIPS Home |
ok_lock_outok_lock_out (routine)
Validate the given lock out term in months for an MBS
Introduced in release: 1.0
Component: US MBS
Purpose:
Test the given lock out term in months for a MBS. This is the period of time during which no prepayments can be made. It must be greater than or equal to 0 and less than or equal to the WAM.
Results:
The value of the function is true (1) if the lock_out is valid. The value of the function is false (0) if the lock_out is invalid. The variable status will contain the reason it is invalid.
Error Conditions:
The variable status contains a non zero value upon returning from the function when the input contains an error.
11401 = lock out months less than zero
11402 = lock out months greater than wam
| Last Mod Date: 01/12/1993 | © 2001 TIPS, Inc. | Doc Version: 5.0 |