next up previous contents
Next: Fetch Menu Title Up: Retained Menu Definition Previous: Modify Menu Title

Fetch Menu Prompt

This Subroutine allows the Prompt associated with currently setup Menu to be fetched (retrieved).

Short Name Calling Sequence

STATUS = UIFHPR(PROMPT[,PRLENG])

Long Name Calling Sequence

STATUS = UI_FETCH_PROMPT(...)

Input Arguments

None

Output Arguments

PROMPT (Character) Menu Prompt Text PRLENG (Integer) Length of Prompt Text (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_MENU ) Illegal Menu ID UIILME )

UI__TRUNCATED ) Button Text Truncated UITRUN ) Note:

  1. This subroutine operates on the currently setup Menu as defined by a prior call to UI_DEFINE_MENU or UI_USE_MENU.
  2. The PRLENG Argument is optional and, if present, will be set to the length of the Menu Prompt Text after any truncation.
  3. The UI__TRUNCATED Function value is informational only, no error message will be signalled.


Liz Buckle
Fri Jan 13 17:39:04 CST 1995