Share via


DXColorFromBSTR function

Converts a BSTR enumerated color to a 32-bit ARGB value.

Syntax

HRESULT DXColorFromBSTR(
  _In_  BSTR  Color,
  _Out_ DWORD *pdwColor
);

Parameters

  • Color [in]
    A value of type BSTR that specifies an enumerated color word, a 24-bit RGB color string of the form "#RRGGBB," or a 32-bit ARGB color string of the form "#AARRGGBB."

  • pdwColor [out]
    A pointer to a value of type DWORD that specifies a 32-bit converted color value indicated by the Color string.

Return value

Returns an HRESULT that indicates whether the color conversion was successful.

Remarks

The input string can be in the "#RRGGBB" color format used in HTML, or it can specify color names. The Color Table contains the valid color names and shows a sample of each color.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Dxclrhlp.h