IDirectDrawSurface::GetColorKey (Compact 2013)

3/26/2014

This method retrieves the color key value for the DirectDrawSurface object.

Syntax

HRESULT GetColorKey(
  DWORD dwFlags, 
  LPDDCOLORKEY lpDDColorKey
);

dwFlags
Determines which color key is requested. The following table shows the possible flags.

Flag	Description
DDCKEY_DESTBLT	Set if the structure specifies a color key or color space to be used as a destination color key for blit operations.
DDCKEY_DESTOVERLAY	Set if the structure specifies a color key or color space to be used as a destination color key for overlay operations.
DDCKEY_SRCBLT	Set if the structure specifies a color key or color space to be used as a source color key for blit operations.
DDCKEY_SRCOVERLAY	Set if the structure specifies a color key or color space to be used as a source color key for overlay operations.

lpDDColorKey
Address of the DDCOLORKEY structure that will be filled with the current values for the specified color key of the DirectDrawSurface object.

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_NOCOLORKEYHW

DDERR_SURFACELOST

DDERR_UNSUPPORTED

For more information on these error codes see DirectDraw Return Values.

Header	ddraw.h
Library	ddraw.lib