Developer

API Reference

IWidget_GetCaretWidget()

Brew Release
Brew MP 1.0.2
See Also
- IWidget
- AEECLSID_CaretWidget
- AEECLSID_TextWidget
- IWidget_Release
- IWidget_SetCaretWidget
Description
This function is used to retrieve the caret widget for the text widget object. The caller is responsible for releasing the caret widget when finished with it.
Parameters
  • pif
    []:
    [in] Pointer to the text widget object.
  • piCaret
    []:
    [out] Pointer to an IWidget pointer. On return points to the caret widget.
Interface
Prototype
   int IWidget_GetCaretWidget(IWidget *pif, IWidget **piCaret)
Return
   AEE_SUCCESS - If BREW was able to successfully retrieve the caret widget.
   AEE_EFAILED - If the caret widget could not be retrieved.
Side Effect
None
Comment
None
  • Follow