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

Developer

API Reference

IWINDOWHISTORY_GETWININFO()

Brew Release
Brew MP 1.0.2
See Also
IWindowHistory IWindowHistory_GetWinIDs() IWindowHistory_OnChange()
Description
This method retrieves information about a specific window
Params
_pif
[in]:
A pointer to the IWindowHistory object.
key
[in]:
A NULL-terminated string representing the information to retrieve
value
[out]:
If valueLen is set to 0, this parameter is ignored. Otherwise, this buffer is filled with as much of the requested window IDs, along with a NULL for termination.
valueLen
[in]:
The total size (in bytes) of the value buffer, or 0 to query for required buffer size only.
valueLenReq
[out]:
On return, valueLenReq is set to the buffer size required to allow the complete value. May also be NULL if the caller doesn't care to know.
Interface
Prototype
  •    AEEResult IWindowHistory_GetWinInfo(IWindowHistory* _pif, uint32 winid, const char* key, char* value, int valueLen, int* valueLenReq)
    
Return
  • AEE_SUCCESS : On success. AEE_ESCHEMENOTSUPPORTED : The requested information is not supported AEE_ERESOURCENOTFOUND : The window id is invalid (e.g. the window was closed and no longer exists) Error code : Otherwise.
Side Effect
  • None
Comments
None