DirectX SDK

DirectDrawSurface7.GetOverlayZOrdersEnum

The DirectDrawSurface7::GetOverlayZOrdersEnum method returns a DirectDrawEnumSurfaces object that is used to enumerate the overlay surfaces on the specified destination. The overlays can be enumerated in front-to-back or back-to-front order.

object.(flags As CONST_DDENUMOVERLAYZFLAGS) _ 
    As DirectDrawEnumSurfaces

Parameters

object
Object expression that resolves to a DirectDrawSurface7 object.
flags
One of the constants of the CONST_DDENUMOVERLAYZFLAGS enumeration specifying enumeration options.

Return Values

If the method succeeds, it returns a DirectDrawEnumSurfaces object that you can then query for overlay surface z-order information.

Error Codes

If the method fails, it raises an error, and Err.Number can be set to one of the following values:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

See Also

DirectDrawSurface7.UpdateOverlayZOrder