CreateCursor 関数 (winuser.h)

[アーティクル]
01/27/2024

指定したサイズ、ビットパターン、ホットスポットを持つモノクロカーソルを作成します。

実行時に色付きカーソルを作成するには、ICONINFO 構造体の内容に基づいてカーソルを作成する CreateIconIndirect 関数を使用できます。

構文

HCURSOR CreateCursor(
  [in, optional] HINSTANCE  hInst,
  [in]           int        xHotSpot,
  [in]           int        yHotSpot,
  [in]           int        nWidth,
  [in]           int        nHeight,
  [in]           const VOID *pvANDPlane,
  [in]           const VOID *pvXORPlane
);

パラメーター

[in, optional] hInst

種類: HINSTANCE

カーソルを作成しているアプリケーションの現在のインスタンスへのハンドル。

[in] xHotSpot

型: int

カーソルのホットスポットの水平方向の位置。

[in] yHotSpot

型: int

カーソルのホットスポットの垂直方向の位置。

[in] nWidth

型: int

カーソルの幅 (ピクセル単位)。

[in] nHeight

型: int

カーソルの高さ (ピクセル単位)。

[in] pvANDPlane

型: const VOID*

モノクロビットマップのように、カーソルの AND マスクのビット値を含むバイト配列。「解説」を参照してください。

[in] pvXORPlane

型: const VOID*

モノクロビットマップのように、カーソルの XOR マスクのビット値を含むバイト配列。「解説」を参照してください。

戻り値

型: HCURSOR

関数が成功した場合、戻り値はカーソルへのハンドルです。

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

解説

カーソルの名目サイズを確認するには、 GetSystemMetrics 関数を使用して、 SM_CXCURSOR または SM_CYCURSOR 値を指定します。また、この API の DPI 対応バージョンを使用することもできます。(GetSystemMetricsForDpi)(/windows/win32/api/winuser/nf-winuser-getsystemmetricsfordpi) を参照してください。詳細については、「 Windows での高 DPI デスクトップアプリケーション開発」を参照してください。

pvANDPlane パラメーターと pvXORPlane パラメーターの詳細については、「CreateBitmap 関数の lpBits パラメーターの説明」を参照してください。

CreateCursor では 、AND ビットマスクと XOR ビットマスクに次の真理値テーブルが適用されます。

AND ビットマスク	XOR ビットマスク	表示
0	0	Black
0	1	White
1	0	Screen
1	1	画面の反転

終了する前に、アプリケーションで DestroyCursor 関数を呼び出して、カーソルに関連付けられているシステムリソースを解放する必要があります。

DPI 仮想化

この API は、DPI 仮想化には参加しません。返される出力は物理座標の観点からであり、呼び出し元スレッドの DPI の影響を受けません。作成されたカーソルは、描画先の特定のウィンドウの DPI と一致するようにスケーリングされる場合があることに注意してください。

例

例については、「カーソルの作成」を参照してください。

要件


サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll