Developer

API Reference

ICanvas_GetDisplay()

Brew Release
Brew MP 1.0.2
See Also
Description
This is an inline function that gets an IDisplay object from an ICanvas object, providing the ICanvas object also supports the IDisplayCanvas interface. This function first performs a QueryInterface for an IDisplayCanvas interface, then if successful, defers to IDisplayCanvas_GetDisplay() to obtain an IDisplay.
Parameters
  • piCanvas
    []:
    [in] Pointer to an ICanvas object.
  • ppo
    []:
    [in] Memory location where the returned IDisplay pointer will be stored.
Interface
Prototype
   int ICanvas_GetDisplay(ICanvas *piCanvas, IDisplay **ppo);
   
Return
   
   AEE_SUCCESS - The function was able to successfully return an IDisplay pointer.
   AEE_EFAILED - The IDisplay pointer was not available.


Side Effect
None
Comment
None
  • Follow