IDirectDrawSurface5::GetColorKey

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

HRESULT GetColorKey(
  DWORD dwFlags, 
  LPDDCOLORKEY lpDDColorKey
); 

Parameters

• 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.

Return Values

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:

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Ddraw.h.
Link Library: Ddraw.lib.

See Also

IDirectDrawSurface5::SetColorKey

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.