Kernel APIs: $$PENDING^XQALBUTL

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

Reference Type: Supported, Category: Alerts, Integration Agreement: 2788

Description

This 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:

1—YES, alert is pending.
0—NO, alert is not pending.

Format

  $$PENDING^XQALBUTL(xqauser,xqaid)

Input Parameters

xqauser:	(required) This is the Internal Entry Number (IEN, DUZ value) in the NEW PERSON file (#200) for the desired user.
xqaid:	(required) This is the value xqaid that is 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

VA (Internet) / VA (Intranet) / OI / HSD&D / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: December 14, 2005

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.