GetLayeredWindowAttributes 関数 (winuser.h)

  • [アーティクル]

レイヤード ウィンドウの不透明度および透明度のカラー キーを取得します。

構文

BOOL GetLayeredWindowAttributes(
  [in]            HWND     hwnd,
  [out, optional] COLORREF *pcrKey,
  [out, optional] BYTE     *pbAlpha,
  [out, optional] DWORD    *pdwFlags
);

パラメーター

[in] hwnd

型: HWND

レイヤード ウィンドウへのハンドル。 レイヤード ウィンドウは、CreateWindowEx 関数を使用してウィンドウを作成するときにWS_EX_LAYEREDを指定するか、ウィンドウの作成後に SetWindowLong を使用してWS_EX_LAYEREDを設定することによって作成されます。

[out, optional] pcrKey

種類: COLORREF*

レイヤード ウィンドウの作成時に使用する透過性カラー キーを受け取る COLORREF 値へのポインター。 ウィンドウによってこの色で塗りつぶされたすべてのピクセルは透明になります。 引数が必要ない場合は 、NULL を指定 できます。

[out, optional] pbAlpha

型: BYTE*

レイヤーウィンドウの不透明度を表すために使用されるアルファ値。 BLENDFUNCTION 構造体の SourceConstantAlpha メンバーと同様です。 pbAlpha によって参照される変数が 0 の場合、ウィンドウは完全に透明になります。 pbAlpha によって参照される変数が 255 の場合、ウィンドウは不透明になります。 引数が必要ない場合は 、NULL を指定 できます。

[out, optional] pdwFlags

型: DWORD*

重ね合うフラグ。 このパラメーターは、値が不要な場合は NULL にすることができます 。 レイヤー フラグには、次の値のうち 1 つ以上を指定できます。

値 意味
LWA_ALPHA
0x00000002
 pbAlpha を使用して、レイヤーウィンドウの不透明度を決定します。
LWA_COLORKEY
0x00000001
 透過性の色として pcrKey を使用します。

戻り値

種類: BOOL

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

GetLayeredWindowAttributes は、アプリケーションが以前にウィンドウで SetLayeredWindowAttributes を呼び出した場合にのみ呼び出すことができます。 レイヤー化されたウィンドウが UpdateLayeredWindow で設定されている場合、関数は失敗します。

詳細については、「 レイヤード ウィンドウの使用」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-window-l1-1-1 (Windows 8.1 で導入)

関連項目

概念

CreateWindowEx

リファレンス

SetLayeredWindowAttributes

SetWindowLong

Windows の使用

Windows