API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ISHELL_PROMPT()

Brew Release
Brew MP 1.0.2
Description
This function provides a mechanism for an application to display a multi-selection prompt. The text can be specified from a resource file or directly passed in the AEEPromptInfo data structure. The AEE shell first examines the text pointers before attempting to load the text from the resource file. The buttons are specified by the values in the AEEPromptInfo->pBtnIDs list. For convenience, it is assumed that the IDs for the buttons are associated with both the text and command ID for the button. If the passed button pointer is NULL, the prompt must successfully be displayed without any button. The prompt dialog is automatically dismissed when the device user selects a button or presses the CLR key. In this case, the EVT_COMMAND message is sent to the application with the 16-bit extra parameter indicating the ID of the selection.
Params
pIShell
[]:
Pointer to the IShell interface object.
pi
[]:
Pointer to the AEEPromptInfo data structure.
Interface
  • ISHELL
Prototype
  •     boolean ISHELL_Prompt(IShell * pIShell, AEEPromptInfo * pi);
    
Return
  • TRUE : if the prompt was created. FALSE : if the prompt was not created.
Side Effect
  • None
Comments
The first button in the pBtnIDs array is always selected (highlighted) when the prompt is instantiated.