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

Developer

API Reference

IJOYSTICK_QUERYINTERFACE()

Brew Release
Brew MP 1.0.2
See Also
None
Description
This function can be used to - Get a pointer to an interface or data based on the input class ID
- Query an extended version of the IJoystick-derived class
- Support version compatibility
Params
pIJoystick
[in]:
Pointer to IJoystick Interface.
clsReq
[in]:
A globally unique id to identify the entity (interface or data) that we are trying to query. (AEECLSID_IJOYSTICK1, AEECLSID_IJOYSTICK2, AEECLSID_IJOYSTICK)
ppo
[out]:
Pointer to the interface or data that we want to retrieve. If the value passed back is NULL, the interface or data that we query are not available.
Interface
  • IJOYSTICK
Prototype
  •    int IJOYSTICK_QueryInterface
       (
       IJoystick * pIJoystick, 
       AEECLSID clsReq, 
       void ** ppo
       )
    
Return
  • SUCCESS: on success, Otherwise: an error code.
Side Effect
  • If an interface is retrieved, then this function increments its reference count.
    If a data structure is retrieved, then a pointer to the internal structure is given and user should not free it.
Comments
If ppo is back a NULL pointer, the interface or data that we query is not available.