Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › LoadCursorA

LoadCursorA

関数
カーソルリソースを読み込みハンドルを返す(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

HCURSOR LoadCursorA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpCursorName
);

パラメーター

名前方向説明
hInstanceHINSTANCEinoptional

読み込むカーソルを含む DLL または実行可能ファイル(.exe)のモジュールへのハンドルです。詳細については、GetModuleHandle を参照してください。

定義済みのシステムカーソルを読み込むには、このパラメーターに NULL を設定します。

lpCursorNameLPCSTRin

hInstanceNULL 以外の場合、lpCursorName は名前または序数によってカーソルリソースを指定します。この序数は MAKEINTRESOURCE マクロを使用してパッケージ化する必要があります。

hInstanceNULL の場合、lpCursorName は読み込む定義済みシステムカーソルの識別子(IDC_ プレフィックスで始まる)を指定します。

戻り値の型: HCURSOR

公式ドキュメント

アプリケーションインスタンスに関連付けられた実行可能ファイル(.EXE)から、指定したカーソルリソースを読み込みます。(ANSI)

戻り値

型: HCURSOR

関数が成功した場合、戻り値は新しく読み込まれたカーソルへのハンドルです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

LoadCursor 関数は、カーソルリソースがまだ読み込まれていない場合にのみ読み込みます。既に読み込まれている場合は、既存のリソースへのハンドルを取得します。この関数が有効なカーソルハンドルを返すのは、lpCursorName パラメーターがカーソルリソースへのポインターである場合に限ります。lpCursorName がカーソル以外の種類のリソース(アイコンなど)へのポインターである場合、戻り値は有効なカーソルハンドルではないにもかかわらず NULL にはなりません。

LoadCursor 関数は、現在の表示デバイスのカーソルに最も適したカーソルリソースを検索します。カーソルリソースはカラーまたはモノクロのビットマップにできます。

DPI 仮想化

この API は DPI 仮想化に対応していません。返される出力は、呼び出し側スレッドの DPI の影響を受けません。

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

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして LoadCursor を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

HCURSOR LoadCursorA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpCursorName
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr LoadCursorA(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpCursorName   // LPCSTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadCursorA(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPStr)> lpCursorName As String   ' LPCSTR
) As IntPtr
End Function
' hInstance : HINSTANCE optional
' lpCursorName : LPCSTR
Declare PtrSafe Function LoadCursorA Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpCursorName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LoadCursorA = ctypes.windll.user32.LoadCursorA
LoadCursorA.restype = ctypes.c_void_p
LoadCursorA.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCSTR,  # lpCursorName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LoadCursorA = Fiddle::Function.new(
  lib['LoadCursorA'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpCursorName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn LoadCursorA(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpCursorName: *const u8  // LPCSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr LoadCursorA(IntPtr hInstance, [MarshalAs(UnmanagedType.LPStr)] string lpCursorName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadCursorA' -Namespace Win32 -PassThru
# $api::LoadCursorA(hInstance, lpCursorName)
#uselib "USER32.dll"
#func global LoadCursorA "LoadCursorA" sptr, sptr
; LoadCursorA hInstance, lpCursorName   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "sptr"
; lpCursorName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LoadCursorA "LoadCursorA" sptr, str
; res = LoadCursorA(hInstance, lpCursorName)
; hInstance : HINSTANCE optional -> "sptr"
; lpCursorName : LPCSTR -> "str"
; HCURSOR LoadCursorA(HINSTANCE hInstance, LPCSTR lpCursorName)
#uselib "USER32.dll"
#cfunc global LoadCursorA "LoadCursorA" intptr, str
; res = LoadCursorA(hInstance, lpCursorName)
; hInstance : HINSTANCE optional -> "intptr"
; lpCursorName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLoadCursorA = user32.NewProc("LoadCursorA")
)

// hInstance (HINSTANCE optional), lpCursorName (LPCSTR)
r1, _, err := procLoadCursorA.Call(
	uintptr(hInstance),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpCursorName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HCURSOR
function LoadCursorA(
  hInstance: THandle;   // HINSTANCE optional
  lpCursorName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadCursorA';
result := DllCall("USER32\LoadCursorA"
    , "Ptr", hInstance   ; HINSTANCE optional
    , "AStr", lpCursorName   ; LPCSTR
    , "Ptr")   ; return: HCURSOR
●LoadCursorA(hInstance, lpCursorName) = DLL("USER32.dll", "void* LoadCursorA(void*, char*)")
# 呼び出し: LoadCursorA(hInstance, lpCursorName)
# hInstance : HINSTANCE optional -> "void*"
# lpCursorName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn LoadCursorA(
    hInstance: ?*anyopaque, // HINSTANCE optional
    lpCursorName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc LoadCursorA(
    hInstance: pointer,  # HINSTANCE optional
    lpCursorName: cstring  # LPCSTR
): pointer {.importc: "LoadCursorA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* LoadCursorA(
    void* hInstance,   // HINSTANCE optional
    const(char)* lpCursorName   // LPCSTR
);
ccall((:LoadCursorA, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cstring),
      hInstance, lpCursorName)
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# lpCursorName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* LoadCursorA(
    void* hInstance,
    const char* lpCursorName);
]]
local user32 = ffi.load("user32")
-- user32.LoadCursorA(hInstance, lpCursorName)
-- hInstance : HINSTANCE optional
-- lpCursorName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadCursorA = lib.func('__stdcall', 'LoadCursorA', 'void *', ['void *', 'str']);
// LoadCursorA(hInstance, lpCursorName)
// hInstance : HINSTANCE optional -> 'void *'
// lpCursorName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LoadCursorA: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.LoadCursorA(hInstance, lpCursorName)
// hInstance : HINSTANCE optional -> "pointer"
// lpCursorName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LoadCursorA(
    void* hInstance,
    const char* lpCursorName);
C, "USER32.dll");
// $ffi->LoadCursorA(hInstance, lpCursorName);
// hInstance : HINSTANCE optional
// lpCursorName : LPCSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.ASCII_OPTIONS);
    Pointer LoadCursorA(
        Pointer hInstance,   // HINSTANCE optional
        String lpCursorName   // LPCSTR
    );
}
@[Link("user32")]
lib LibUSER32
  fun LoadCursorA = LoadCursorA(
    hInstance : Void*,   # HINSTANCE optional
    lpCursorName : UInt8*   # LPCSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LoadCursorANative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
typedef LoadCursorADart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
final LoadCursorA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<LoadCursorANative, LoadCursorADart>('LoadCursorA');
// hInstance : HINSTANCE optional -> Pointer<Void>
// lpCursorName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadCursorA(
  hInstance: THandle;   // HINSTANCE optional
  lpCursorName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadCursorA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LoadCursorA"
  c_LoadCursorA :: Ptr () -> CString -> IO (Ptr ())
-- hInstance : HINSTANCE optional -> Ptr ()
-- lpCursorName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let loadcursora =
  foreign "LoadCursorA"
    ((ptr void) @-> string @-> returning (ptr void))
(* hInstance : HINSTANCE optional -> (ptr void) *)
(* lpCursorName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("LoadCursorA" load-cursor-a :convention :stdcall) :pointer
  (h-instance :pointer)   ; HINSTANCE optional
  (lp-cursor-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LoadCursorA = Win32::API::More->new('USER32',
    'HANDLE LoadCursorA(HANDLE hInstance, LPCSTR lpCursorName)');
# my $ret = $LoadCursorA->Call($hInstance, $lpCursorName);
# hInstance : HINSTANCE optional -> HANDLE
# lpCursorName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目