IFLIP_GetDisplayList() | developer.brewmp.com IFLIP_GetDisplayList() | developer.brewmp.com

Developer

IFLIP_GetDisplayList()

IFLIP_GETDISPLAYLIST()

Brew Release
Brew MP 1.0.2
See Also
Description
This function retrieves the display class IDs of the displays accessible to user based on the current positions of all flips.
The display class IDs are returned in the AEECLSID array that is passed in the pClsList argument. The caller allocates the array and indicates the array size in pnCount.
The caller can pass in a NULL value of pClsList in order to retrieve just the number of displays accessible. In this case, pnCount should contain a valid int16 pointer.
If the function returns AEE_SUCCESS or AEE_EBUFFERTOOSMALL, pnCount contains the number of displays accessible. The function returns AEE_EBUFFERTOOSMALL if the size of the pClsList array is smaller than the number of displays accessible.
If pnCount = 0, it means there are no displays accessible. If the function returns AEE_SUCCESS, and pnCount > 0, then pnCount is the number of displays accessible. If the caller passed in a valid AEECLSID array via pClsList, then pClsList contains the display class IDs of the displays accessible.
Params
pIFlip
[in]:
Pointer to the IFlip Interface object.
pClsList
[out]:
Pointer to the array of AEECLSID. Can be NULL. If the function returns AEE_SUCCESS and pClsList is not NULL, it contains the display class IDs of the displays accessible.
pnCount
[]:
[in] [out] : Caller indicates the size of the array of AEECLSID passed in via pClsList. If the function returns SUCCESS, this parameter contains the number of displays accessible.
Interface
  • IFLIP
Prototype
  •    int IFLIP_GetDisplayList
       (
       IFlip * pIFlip,
       AEECLSID * pClsList,
       int16 * pnCount
       );
    
Return
  • AEE_SUCCESS: if successful. AEE_EBADPARM: invalid parameter. AEE_EBUFFERTOOSMALL: buffer specified by caller is too small. AEE_EFAILED: other failure.
Side Effect
  • None
Comments
See IDisplay interface documentation for various display class IDs.