Kernel V. 8.0 APIs Banner [skip navigation]
VHA Office of Information - Health Systems Design and Development (HSD&D) Banner

OP^XQCHK(): Current Option Check

Reference Type: Supported, Category: Menu Manager, Integration Agreement: 10078

Description

This API returns the current option or protocol name and menu text in the first and second pieces of the xqopt output parameter. It looks for the local XQY variable, the internal number of the option, or XQORNOD, the internal number of the protocol.

If the search is unsuccessful, because the job is not running out of the menu system or is not a tasked option, xqopt is returned with -1 in the first piece and "Unknown" in the second.

NOTE: XQCHK cannot return option/protocol information if the job is a task that did not originate from an option.

Format

  OP^XQCHK(xqopt)

Input Parameters

none

 

Output Parameters

xqopt:

Returns a string in the following format:

  Option/Protocol Name^Menu Text

If neither an option nor a protocol can be identified, xqopt is returned as:

  -1^Unknown

Example

 
	 
 
 
 
	 
 
		
 
		  
			 

			 

				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.