SHDefExtractIconA
関数ファイル(ANSI)から既定の方法でアイコンを抽出する。
シグネチャ
// SHELL32.dll (ANSI / -A)
#include <windows.h>
HRESULT SHDefExtractIconA(
LPCSTR pszIconFile,
INT iIndex,
DWORD uFlags,
HICON* phiconLarge, // optional
HICON* phiconSmall, // optional
DWORD nIconSize
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszIconFile | LPCSTR | in | アイコンの抽出元となるファイルのパスと名前を含む、null で終わるバッファーへのポインター。 |
| iIndex | INT | in | pszIconFile で指定したファイル内でのアイコンの位置。正の数の場合は、ファイル内のアイコンの 0 から始まる位置を指します。たとえば、0 はリソースファイル内の 1 番目のアイコンを、2 は 3 番目のアイコンを指します。負の数の場合は、アイコンのリソース ID を指します。 |
| uFlags | DWORD | in | アイコンの抽出を制御するフラグ。 GIL_SIMULATEDOC抽出したアイコンを既定のドキュメントアイコンに重ねて、最終的なアイコンを作成します。より適切なアイコンが見つからない、または取得できない場合に、このアイコンを使用できます。 |
| phiconLarge | HICON* | outoptional | HICON へのポインター。この関数が正常に終了すると、nIconSize の LOWORD で指定されたサイズの大きいバージョンのアイコンのハンドルを受け取ります。この値は NULL にできます。 |
| phiconSmall | HICON* | outoptional | HICON へのポインター。この関数が正常に終了すると、nIconSize の HIWORD で指定されたサイズの小さいバージョンのアイコンのハンドルを受け取ります。 |
| nIconSize | DWORD | in | LOWORD に大きいアイコンのサイズを、HIWORD に小さいアイコンのサイズを含む値。サイズはピクセル単位で指定します。既定の大きいサイズと小さいサイズを指定するには 0 を渡します。 |
戻り値の型: HRESULT
公式ドキュメント
ファイルからアイコンを抽出するための既定のハンドラーを提供します。(ANSI)
戻り値
型: HRESULT
この関数は次のいずれかの値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| 成功しました。 | |
| 要求されたアイコンが存在しません。 | |
| ファイルにアクセスできない、または低速なリンク経由でアクセスされています。 |
解説(Remarks)
この関数によって作成されたアイコンリソースが不要になったときに解放するのは、呼び出し元の責任です。これは DestroyIcon 関数によって行えます。
メモ
shlobj_core.h ヘッダーは SHDefExtractIcon をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll (ANSI / -A)
#include <windows.h>
HRESULT SHDefExtractIconA(
LPCSTR pszIconFile,
INT iIndex,
DWORD uFlags,
HICON* phiconLarge, // optional
HICON* phiconSmall, // optional
DWORD nIconSize
);[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHDefExtractIconA(
[MarshalAs(UnmanagedType.LPStr)] string pszIconFile, // LPCSTR
int iIndex, // INT
uint uFlags, // DWORD
IntPtr phiconLarge, // HICON* optional, out
IntPtr phiconSmall, // HICON* optional, out
uint nIconSize // DWORD
);<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHDefExtractIconA(
<MarshalAs(UnmanagedType.LPStr)> pszIconFile As String, ' LPCSTR
iIndex As Integer, ' INT
uFlags As UInteger, ' DWORD
phiconLarge As IntPtr, ' HICON* optional, out
phiconSmall As IntPtr, ' HICON* optional, out
nIconSize As UInteger ' DWORD
) As Integer
End Function' pszIconFile : LPCSTR
' iIndex : INT
' uFlags : DWORD
' phiconLarge : HICON* optional, out
' phiconSmall : HICON* optional, out
' nIconSize : DWORD
Declare PtrSafe Function SHDefExtractIconA Lib "shell32" ( _
ByVal pszIconFile As String, _
ByVal iIndex As Long, _
ByVal uFlags As Long, _
ByVal phiconLarge As LongPtr, _
ByVal phiconSmall As LongPtr, _
ByVal nIconSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHDefExtractIconA = ctypes.windll.shell32.SHDefExtractIconA
SHDefExtractIconA.restype = ctypes.c_int
SHDefExtractIconA.argtypes = [
wintypes.LPCSTR, # pszIconFile : LPCSTR
ctypes.c_int, # iIndex : INT
wintypes.DWORD, # uFlags : DWORD
ctypes.c_void_p, # phiconLarge : HICON* optional, out
ctypes.c_void_p, # phiconSmall : HICON* optional, out
wintypes.DWORD, # nIconSize : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
SHDefExtractIconA = Fiddle::Function.new(
lib['SHDefExtractIconA'],
[
Fiddle::TYPE_VOIDP, # pszIconFile : LPCSTR
Fiddle::TYPE_INT, # iIndex : INT
-Fiddle::TYPE_INT, # uFlags : DWORD
Fiddle::TYPE_VOIDP, # phiconLarge : HICON* optional, out
Fiddle::TYPE_VOIDP, # phiconSmall : HICON* optional, out
-Fiddle::TYPE_INT, # nIconSize : DWORD
],
Fiddle::TYPE_INT)#[link(name = "shell32")]
extern "system" {
fn SHDefExtractIconA(
pszIconFile: *const u8, // LPCSTR
iIndex: i32, // INT
uFlags: u32, // DWORD
phiconLarge: *mut *mut core::ffi::c_void, // HICON* optional, out
phiconSmall: *mut *mut core::ffi::c_void, // HICON* optional, out
nIconSize: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern int SHDefExtractIconA([MarshalAs(UnmanagedType.LPStr)] string pszIconFile, int iIndex, uint uFlags, IntPtr phiconLarge, IntPtr phiconSmall, uint nIconSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHDefExtractIconA' -Namespace Win32 -PassThru
# $api::SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)#uselib "SHELL32.dll"
#func global SHDefExtractIconA "SHDefExtractIconA" sptr, sptr, sptr, sptr, sptr, sptr
; SHDefExtractIconA pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize ; 戻り値は stat
; pszIconFile : LPCSTR -> "sptr"
; iIndex : INT -> "sptr"
; uFlags : DWORD -> "sptr"
; phiconLarge : HICON* optional, out -> "sptr"
; phiconSmall : HICON* optional, out -> "sptr"
; nIconSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHELL32.dll"
#cfunc global SHDefExtractIconA "SHDefExtractIconA" str, int, int, sptr, sptr, int
; res = SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
; pszIconFile : LPCSTR -> "str"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; phiconLarge : HICON* optional, out -> "sptr"
; phiconSmall : HICON* optional, out -> "sptr"
; nIconSize : DWORD -> "int"; HRESULT SHDefExtractIconA(LPCSTR pszIconFile, INT iIndex, DWORD uFlags, HICON* phiconLarge, HICON* phiconSmall, DWORD nIconSize)
#uselib "SHELL32.dll"
#cfunc global SHDefExtractIconA "SHDefExtractIconA" str, int, int, intptr, intptr, int
; res = SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
; pszIconFile : LPCSTR -> "str"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; phiconLarge : HICON* optional, out -> "intptr"
; phiconSmall : HICON* optional, out -> "intptr"
; nIconSize : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHDefExtractIconA = shell32.NewProc("SHDefExtractIconA")
)
// pszIconFile (LPCSTR), iIndex (INT), uFlags (DWORD), phiconLarge (HICON* optional, out), phiconSmall (HICON* optional, out), nIconSize (DWORD)
r1, _, err := procSHDefExtractIconA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszIconFile))),
uintptr(iIndex),
uintptr(uFlags),
uintptr(phiconLarge),
uintptr(phiconSmall),
uintptr(nIconSize),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction SHDefExtractIconA(
pszIconFile: PAnsiChar; // LPCSTR
iIndex: Integer; // INT
uFlags: DWORD; // DWORD
phiconLarge: Pointer; // HICON* optional, out
phiconSmall: Pointer; // HICON* optional, out
nIconSize: DWORD // DWORD
): Integer; stdcall;
external 'SHELL32.dll' name 'SHDefExtractIconA';result := DllCall("SHELL32\SHDefExtractIconA"
, "AStr", pszIconFile ; LPCSTR
, "Int", iIndex ; INT
, "UInt", uFlags ; DWORD
, "Ptr", phiconLarge ; HICON* optional, out
, "Ptr", phiconSmall ; HICON* optional, out
, "UInt", nIconSize ; DWORD
, "Int") ; return: HRESULT●SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize) = DLL("SHELL32.dll", "int SHDefExtractIconA(char*, int, dword, void*, void*, dword)")
# 呼び出し: SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
# pszIconFile : LPCSTR -> "char*"
# iIndex : INT -> "int"
# uFlags : DWORD -> "dword"
# phiconLarge : HICON* optional, out -> "void*"
# phiconSmall : HICON* optional, out -> "void*"
# nIconSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shell32" fn SHDefExtractIconA(
pszIconFile: [*c]const u8, // LPCSTR
iIndex: i32, // INT
uFlags: u32, // DWORD
phiconLarge: ?*anyopaque, // HICON* optional, out
phiconSmall: ?*anyopaque, // HICON* optional, out
nIconSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc SHDefExtractIconA(
pszIconFile: cstring, # LPCSTR
iIndex: int32, # INT
uFlags: uint32, # DWORD
phiconLarge: pointer, # HICON* optional, out
phiconSmall: pointer, # HICON* optional, out
nIconSize: uint32 # DWORD
): int32 {.importc: "SHDefExtractIconA", stdcall, dynlib: "SHELL32.dll".}pragma(lib, "shell32");
extern(Windows)
int SHDefExtractIconA(
const(char)* pszIconFile, // LPCSTR
int iIndex, // INT
uint uFlags, // DWORD
void* phiconLarge, // HICON* optional, out
void* phiconSmall, // HICON* optional, out
uint nIconSize // DWORD
);ccall((:SHDefExtractIconA, "SHELL32.dll"), stdcall, Int32,
(Cstring, Int32, UInt32, Ptr{Cvoid}, Ptr{Cvoid}, UInt32),
pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
# pszIconFile : LPCSTR -> Cstring
# iIndex : INT -> Int32
# uFlags : DWORD -> UInt32
# phiconLarge : HICON* optional, out -> Ptr{Cvoid}
# phiconSmall : HICON* optional, out -> Ptr{Cvoid}
# nIconSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SHDefExtractIconA(
const char* pszIconFile,
int32_t iIndex,
uint32_t uFlags,
void* phiconLarge,
void* phiconSmall,
uint32_t nIconSize);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
-- pszIconFile : LPCSTR
-- iIndex : INT
-- uFlags : DWORD
-- phiconLarge : HICON* optional, out
-- phiconSmall : HICON* optional, out
-- nIconSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHDefExtractIconA = lib.func('__stdcall', 'SHDefExtractIconA', 'int32_t', ['str', 'int32_t', 'uint32_t', 'void *', 'void *', 'uint32_t']);
// SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
// pszIconFile : LPCSTR -> 'str'
// iIndex : INT -> 'int32_t'
// uFlags : DWORD -> 'uint32_t'
// phiconLarge : HICON* optional, out -> 'void *'
// phiconSmall : HICON* optional, out -> 'void *'
// nIconSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHDefExtractIconA: { parameters: ["buffer", "i32", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
// pszIconFile : LPCSTR -> "buffer"
// iIndex : INT -> "i32"
// uFlags : DWORD -> "u32"
// phiconLarge : HICON* optional, out -> "pointer"
// phiconSmall : HICON* optional, out -> "pointer"
// nIconSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHDefExtractIconA(
const char* pszIconFile,
int32_t iIndex,
uint32_t uFlags,
void* phiconLarge,
void* phiconSmall,
uint32_t nIconSize);
C, "SHELL32.dll");
// $ffi->SHDefExtractIconA(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
// pszIconFile : LPCSTR
// iIndex : INT
// uFlags : DWORD
// phiconLarge : HICON* optional, out
// phiconSmall : HICON* optional, out
// nIconSize : DWORD
// 構造体/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 Shell32 extends StdCallLibrary {
Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.ASCII_OPTIONS);
int SHDefExtractIconA(
String pszIconFile, // LPCSTR
int iIndex, // INT
int uFlags, // DWORD
Pointer phiconLarge, // HICON* optional, out
Pointer phiconSmall, // HICON* optional, out
int nIconSize // DWORD
);
}@[Link("shell32")]
lib LibSHELL32
fun SHDefExtractIconA = SHDefExtractIconA(
pszIconFile : UInt8*, # LPCSTR
iIndex : Int32, # INT
uFlags : UInt32, # DWORD
phiconLarge : Void*, # HICON* optional, out
phiconSmall : Void*, # HICON* optional, out
nIconSize : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHDefExtractIconANative = Int32 Function(Pointer<Utf8>, Int32, Uint32, Pointer<Void>, Pointer<Void>, Uint32);
typedef SHDefExtractIconADart = int Function(Pointer<Utf8>, int, int, Pointer<Void>, Pointer<Void>, int);
final SHDefExtractIconA = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHDefExtractIconANative, SHDefExtractIconADart>('SHDefExtractIconA');
// pszIconFile : LPCSTR -> Pointer<Utf8>
// iIndex : INT -> Int32
// uFlags : DWORD -> Uint32
// phiconLarge : HICON* optional, out -> Pointer<Void>
// phiconSmall : HICON* optional, out -> Pointer<Void>
// nIconSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHDefExtractIconA(
pszIconFile: PAnsiChar; // LPCSTR
iIndex: Integer; // INT
uFlags: DWORD; // DWORD
phiconLarge: Pointer; // HICON* optional, out
phiconSmall: Pointer; // HICON* optional, out
nIconSize: DWORD // DWORD
): Integer; stdcall;
external 'SHELL32.dll' name 'SHDefExtractIconA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHDefExtractIconA"
c_SHDefExtractIconA :: CString -> Int32 -> Word32 -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- pszIconFile : LPCSTR -> CString
-- iIndex : INT -> Int32
-- uFlags : DWORD -> Word32
-- phiconLarge : HICON* optional, out -> Ptr ()
-- phiconSmall : HICON* optional, out -> Ptr ()
-- nIconSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shdefextracticona =
foreign "SHDefExtractIconA"
(string @-> int32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* pszIconFile : LPCSTR -> string *)
(* iIndex : INT -> int32_t *)
(* uFlags : DWORD -> uint32_t *)
(* phiconLarge : HICON* optional, out -> (ptr void) *)
(* phiconSmall : HICON* optional, out -> (ptr void) *)
(* nIconSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHDefExtractIconA" shdef-extract-icon-a :convention :stdcall) :int32
(psz-icon-file :string) ; LPCSTR
(i-index :int32) ; INT
(u-flags :uint32) ; DWORD
(phicon-large :pointer) ; HICON* optional, out
(phicon-small :pointer) ; HICON* optional, out
(n-icon-size :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHDefExtractIconA = Win32::API::More->new('SHELL32',
'int SHDefExtractIconA(LPCSTR pszIconFile, int iIndex, DWORD uFlags, HANDLE phiconLarge, HANDLE phiconSmall, DWORD nIconSize)');
# my $ret = $SHDefExtractIconA->Call($pszIconFile, $iIndex, $uFlags, $phiconLarge, $phiconSmall, $nIconSize);
# pszIconFile : LPCSTR -> LPCSTR
# iIndex : INT -> int
# uFlags : DWORD -> DWORD
# phiconLarge : HICON* optional, out -> HANDLE
# phiconSmall : HICON* optional, out -> HANDLE
# nIconSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SHDefExtractIconW (Unicode版) — ファイル(Unicode)から既定の方法でアイコンを抽出する。