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

LoadCursorFromFileA

関数
ファイルからカーソルやアニメカーソルを読み込む(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HCURSOR LoadCursorFromFileA(
    LPCSTR lpFileName
);

パラメーター

名前方向説明
lpFileNameLPCSTRin

カーソルの作成に使用するファイルデータのソースです。ファイル内のデータは .CUR または .ANI 形式である必要があります。

lpFileName の上位ワードが 0 以外の場合、これはカーソルデータを含むファイルの完全修飾名を表す文字列へのポインターです。

戻り値の型: HCURSOR

公式ドキュメント

ファイルに含まれるデータに基づいてカーソルを作成します。(ANSI)

戻り値

型: HCURSOR

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

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次の値を返すことがあります。

戻り値 説明
ERROR_FILE_NOT_FOUND
指定されたファイルが見つかりません。

解説(Remarks)

DPI 仮想化

この API は DPI 仮想化に参加しません。返される出力は、呼び出し元スレッドの DPI の影響を受けません。
メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして LoadCursorFromFile を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不整合が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 LoadCursorFromFileA(
    LPCSTR lpFileName
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr LoadCursorFromFileA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName   // LPCSTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadCursorFromFileA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String   ' LPCSTR
) As IntPtr
End Function
' lpFileName : LPCSTR
Declare PtrSafe Function LoadCursorFromFileA Lib "user32" ( _
    ByVal lpFileName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LoadCursorFromFileA = ctypes.windll.user32.LoadCursorFromFileA
LoadCursorFromFileA.restype = ctypes.c_void_p
LoadCursorFromFileA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LoadCursorFromFileA = Fiddle::Function.new(
  lib['LoadCursorFromFileA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn LoadCursorFromFileA(
        lpFileName: *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 LoadCursorFromFileA([MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadCursorFromFileA' -Namespace Win32 -PassThru
# $api::LoadCursorFromFileA(lpFileName)
#uselib "USER32.dll"
#func global LoadCursorFromFileA "LoadCursorFromFileA" sptr
; LoadCursorFromFileA lpFileName   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LoadCursorFromFileA "LoadCursorFromFileA" str
; res = LoadCursorFromFileA(lpFileName)
; lpFileName : LPCSTR -> "str"
; HCURSOR LoadCursorFromFileA(LPCSTR lpFileName)
#uselib "USER32.dll"
#cfunc global LoadCursorFromFileA "LoadCursorFromFileA" str
; res = LoadCursorFromFileA(lpFileName)
; lpFileName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLoadCursorFromFileA = user32.NewProc("LoadCursorFromFileA")
)

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

extern "user32" fn LoadCursorFromFileA(
    lpFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc LoadCursorFromFileA(
    lpFileName: cstring  # LPCSTR
): pointer {.importc: "LoadCursorFromFileA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* LoadCursorFromFileA(
    const(char)* lpFileName   // LPCSTR
);
ccall((:LoadCursorFromFileA, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Cstring,),
      lpFileName)
# lpFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* LoadCursorFromFileA(
    const char* lpFileName);
]]
local user32 = ffi.load("user32")
-- user32.LoadCursorFromFileA(lpFileName)
-- lpFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadCursorFromFileA = lib.func('__stdcall', 'LoadCursorFromFileA', 'void *', ['str']);
// LoadCursorFromFileA(lpFileName)
// lpFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LoadCursorFromFileA: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.LoadCursorFromFileA(lpFileName)
// lpFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LoadCursorFromFileA(
    const char* lpFileName);
C, "USER32.dll");
// $ffi->LoadCursorFromFileA(lpFileName);
// lpFileName : 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 LoadCursorFromFileA(
        String lpFileName   // LPCSTR
    );
}
@[Link("user32")]
lib LibUSER32
  fun LoadCursorFromFileA = LoadCursorFromFileA(
    lpFileName : 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 LoadCursorFromFileANative = Pointer<Void> Function(Pointer<Utf8>);
typedef LoadCursorFromFileADart = Pointer<Void> Function(Pointer<Utf8>);
final LoadCursorFromFileA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<LoadCursorFromFileANative, LoadCursorFromFileADart>('LoadCursorFromFileA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadCursorFromFileA(
  lpFileName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadCursorFromFileA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

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