LOCK MANAGER APIs    ICR (5832)

Description:  The purpose of this API is to register
a cleanup
routine that should be executed when the process is terminated
by the Kernel Lock Manager.  An entry is created on a stack kept
for the process.  The location is ^XTMP("XULM CLEANUP_"_$J) where
$J uniquely identifies the process.  A process may call
SETCLEAN^XULMU repeatedly, and each time a new entry is placed on
the stack.

*Important*: Once an application calls SETCLEAN, upon exiting it must
either execute its housecleaning stack or delete it, using
the APIs CLEAN or UNCLEAN.


Example:  Suppose the application has a cleanup routine
CLEANUP^XXAPP, and it needs to be executed with DFN defined
with its present valued.  The application would use this API
as follows:
N VAR,CLEANUP
S VAR("DFN")=DFN
S CLEANUP=$$SETCLEAN^XULMU("CLEANUP^XXAPP",.VAR)

The application's housekeeping stack would look like this:

^XTMP("XULM CLEANUP",$J,1,"ROUTINE")="CLEANUP^XXAPP"
^XTMP("XULM CLEANUP",$J,1,"VARIABLES","DFN")=1000061

Description - this removes entries from the
housecleaning stack set by
calling SETCLEAN^XULMU. Entries are removed in FIFO order.  If LAST is
not passed in, then the entire stack is deleted, otherwise just the
entries back to LAST are removed.

Example: This would remove the entire housecleaning stack:

DO UNCLEAN^XULMU

Example: If an application is called by another application, then the
the first application may have already placed entries of its
own on the stack.   So the parameter LAST needs to be passed,
with LAST being the first entry placed on the stack.  It will
be the last entry deleted, since that stack is executed in
FIFO order.


DO UNCLEAN^XULMU(LAST)

Description:  This API will execute the housecleaning
stack set by the
process identified by DOLLARJ. Entries are executed in the FIFO order,
with the last entry added being the first to be executed, and LAST
being the last entry executed. If LAST is not passed in,
then the entire stack is executed.


Example:  An application may execute the entire housecleaning stack
with the following code:

DO CLEANUP^XULMU

Example:  If an application is called by another application, then the
the first application may have already placed entries of its
own on the stack.   So the parameter LAST needs to be passed,
with LAST being the first entry placed on the stack.  It will
be the last entry executed, since that stack is executed in
FIFO order.

DO CLEANUP^XULM(LAST)

Description: This is for use within the MUMPS code
for a computable file reference to the PATIENT file (#2).  It returns a
standard set of patient identifiers.



Example of Use: Assuming that DFN is a variable defined within the lock
template, then the MUMPS code for a computable file reference to the Patient
file (#2) would consist of the following:

DO PAT^XULMU(DFN)

Description: This API is very similar to PAT^XULMU,
except that it is used to add the patient identifiers for a computable file
reference for a file that is not the PATIENT file (#2).  The computable file
references may include additional identifiers.  For example, a computable file
reference for a billing file may contain the bill number as an identifier as
well as the patient identifiers returned by ADDPAT^XULMU.