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

$$PENDING^XQALBUTL(): Pending Alerts for a User

Reference Type: Supported, Category: Alerts, ICR#: 2788

Description

The $$PENDING^XQALBUTL extrinsic function returns whether or not the user specified has the alert indicated by the xqaid input parameter as pending. It returns either of the following:

Format

  $$PENDING^XQALBUTL(xqauser,xqaid)

Input Parameters

xqauser:

(required) This is the Internal Entry Number (IEN, DUZ value) in the NEW PERSON (#200) file for the desired user.
xqaid:

(required) This is the value of the alert identifier. It is passed to the routine or option that is run when the alert is selected. It can also be obtained from a listing of all of the xqaid values for a specified user and/or patient.

Output

returns:

Returns:

  • 1—YES, alert is pending.

  • 0—NO, alert is not pending.

Example 1

The following is an example of an alert not pending:

>S XQAID="NO-ID;20;2990212.11294719"

>W $$PENDING^XQALBUTL(20,XQAID)
0

Example 2

The following is an example of an alert pending:

>S XQAID="NO-ID;20;2990212.15540723"

>W $$PENDING^XQALBUTL(20,XQAID)
1