Kernel APIs: $$GETSURO^XQALSURO

$$GETSURO^XQALSURO(): Get Current Surrogate Information

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

Description

This extrinsic function returns the following string of information on the current surrogate for the user with XQAUSER as his or her Internal Entry Number (IEN) in the NEW PERSON file (#200):

  ien^NAME^FM_STARTDATE^FM_ENDDATE

If there is no surrogate, the result will be:

^^^

If either of the date/times are not specified, they will return a null value for that piece of the return string.

NOTE: For a description of each piece of information separated by the caret ("^"), please refer to the "Output" section.

Format

  $$GETSURO^XQALSURO(xqauser)

Input Parameters

xqauser:

(required) This is the Internal Entry Number (IEN) in the NEW PERSON file (#200) of the user for whom the alert surrogate information is to be returned.

Output

returns:

Returns the following string of information, each piece separated by a caret ("^"):

  IEN^NAME^FM_STARTDATE^FM_ENDDATE

IEN—Internal Entry Number (IEN) of the SURROGATE in the NEW PERSON file (#200).
NAME—Contents of the .01 field for the SURROGATE.
FM_STARTDATE—Starting date/time for the SURROGATE in internal VA FileMan format.
FM_ENDDATE—Ending date/time for the SURROGATE in internal VA FileMan format.

Example

>S X=$$GETSURO^XQALSURO(124)

>W X
2327^KRNUSER,FOUR^3000929.1630^3001006.0800

This indicates that user #2327 (Four Krnuser) will become active as surrogate at 4:30 PM 9/29/00 and will remain surrogate until 8:00 am on 10/06/00.

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.