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

SHCreateFileExtractIconW

関数
ファイルからアイコン抽出用のIExtractIconを生成する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHCreateFileExtractIconW(
    LPCWSTR pszFile,
    DWORD dwFileAttributes,
    const GUID* riid,
    void** ppv
);

パラメーター

名前方向説明
pszFileLPCWSTRinファイルシステムオブジェクトを指定する null 終端文字列へのポインター。バッファーの長さは MAX_PATH 文字を超えてはなりません。
dwFileAttributesDWORDinオブジェクトの種類を指定する 1 つ以上のファイル属性フラグ(Winnt.h で定義されている FILE_ATTRIBUTE_* 値)の組み合わせ。
riidGUID*in作成するアイコン抽出インターフェイスの目的のインターフェイス ID への参照。IID_IExtractIconA または IID_IExtractIconW のいずれかである必要があります。
ppvvoid**outこの関数が返るとき、riid で要求されたインターフェイスポインターが格納されます。これは通常 IExtractIcon です。

戻り値の型: HRESULT

公式ドキュメント

SHCreateFileExtractIcon は変更されるか、利用できなくなる可能性があります。(Unicode)

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHCreateFileExtractIconW(
    LPCWSTR pszFile,
    DWORD dwFileAttributes,
    const GUID* riid,
    void** ppv
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHCreateFileExtractIconW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszFile,   // LPCWSTR
    uint dwFileAttributes,   // DWORD
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHCreateFileExtractIconW(
    <MarshalAs(UnmanagedType.LPWStr)> pszFile As String,   ' LPCWSTR
    dwFileAttributes As UInteger,   ' DWORD
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function
' pszFile : LPCWSTR
' dwFileAttributes : DWORD
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHCreateFileExtractIconW Lib "shell32" ( _
    ByVal pszFile As LongPtr, _
    ByVal dwFileAttributes As Long, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHCreateFileExtractIconW = ctypes.windll.shell32.SHCreateFileExtractIconW
SHCreateFileExtractIconW.restype = ctypes.c_int
SHCreateFileExtractIconW.argtypes = [
    wintypes.LPCWSTR,  # pszFile : LPCWSTR
    wintypes.DWORD,  # dwFileAttributes : DWORD
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateFileExtractIconW = Fiddle::Function.new(
  lib['SHCreateFileExtractIconW'],
  [
    Fiddle::TYPE_VOIDP,  # pszFile : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFileAttributes : DWORD
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shell32")]
extern "system" {
    fn SHCreateFileExtractIconW(
        pszFile: *const u16,  // LPCWSTR
        dwFileAttributes: u32,  // DWORD
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHCreateFileExtractIconW([MarshalAs(UnmanagedType.LPWStr)] string pszFile, uint dwFileAttributes, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateFileExtractIconW' -Namespace Win32 -PassThru
# $api::SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv)
#uselib "SHELL32.dll"
#func global SHCreateFileExtractIconW "SHCreateFileExtractIconW" wptr, wptr, wptr, wptr
; SHCreateFileExtractIconW pszFile, dwFileAttributes, varptr(riid), ppv   ; 戻り値は stat
; pszFile : LPCWSTR -> "wptr"
; dwFileAttributes : DWORD -> "wptr"
; riid : GUID* -> "wptr"
; ppv : void** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHCreateFileExtractIconW "SHCreateFileExtractIconW" wstr, int, var, sptr
; res = SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv)
; pszFile : LPCWSTR -> "wstr"
; dwFileAttributes : DWORD -> "int"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHCreateFileExtractIconW(LPCWSTR pszFile, DWORD dwFileAttributes, GUID* riid, void** ppv)
#uselib "SHELL32.dll"
#cfunc global SHCreateFileExtractIconW "SHCreateFileExtractIconW" wstr, int, var, intptr
; res = SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv)
; pszFile : LPCWSTR -> "wstr"
; dwFileAttributes : DWORD -> "int"
; riid : GUID* -> "var"
; ppv : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHCreateFileExtractIconW = shell32.NewProc("SHCreateFileExtractIconW")
)

// pszFile (LPCWSTR), dwFileAttributes (DWORD), riid (GUID*), ppv (void** out)
r1, _, err := procSHCreateFileExtractIconW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszFile))),
	uintptr(dwFileAttributes),
	uintptr(riid),
	uintptr(ppv),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHCreateFileExtractIconW(
  pszFile: PWideChar;   // LPCWSTR
  dwFileAttributes: DWORD;   // DWORD
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHCreateFileExtractIconW';
result := DllCall("SHELL32\SHCreateFileExtractIconW"
    , "WStr", pszFile   ; LPCWSTR
    , "UInt", dwFileAttributes   ; DWORD
    , "Ptr", riid   ; GUID*
    , "Ptr", ppv   ; void** out
    , "Int")   ; return: HRESULT
●SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv) = DLL("SHELL32.dll", "int SHCreateFileExtractIconW(char*, dword, void*, void*)")
# 呼び出し: SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv)
# pszFile : LPCWSTR -> "char*"
# dwFileAttributes : DWORD -> "dword"
# riid : GUID* -> "void*"
# ppv : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shell32" fn SHCreateFileExtractIconW(
    pszFile: [*c]const u16, // LPCWSTR
    dwFileAttributes: u32, // DWORD
    riid: [*c]GUID, // GUID*
    ppv: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHCreateFileExtractIconW(
    pszFile: WideCString,  # LPCWSTR
    dwFileAttributes: uint32,  # DWORD
    riid: ptr GUID,  # GUID*
    ppv: pointer  # void** out
): int32 {.importc: "SHCreateFileExtractIconW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
int SHCreateFileExtractIconW(
    const(wchar)* pszFile,   // LPCWSTR
    uint dwFileAttributes,   // DWORD
    GUID* riid,   // GUID*
    void** ppv   // void** out
);
ccall((:SHCreateFileExtractIconW, "SHELL32.dll"), stdcall, Int32,
      (Cwstring, UInt32, Ptr{GUID}, Ptr{Cvoid}),
      pszFile, dwFileAttributes, riid, ppv)
# pszFile : LPCWSTR -> Cwstring
# dwFileAttributes : DWORD -> UInt32
# riid : GUID* -> Ptr{GUID}
# ppv : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHCreateFileExtractIconW(
    const uint16_t* pszFile,
    uint32_t dwFileAttributes,
    void* riid,
    void** ppv);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv)
-- pszFile : LPCWSTR
-- dwFileAttributes : DWORD
-- riid : GUID*
-- ppv : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHCreateFileExtractIconW = lib.func('__stdcall', 'SHCreateFileExtractIconW', 'int32_t', ['str16', 'uint32_t', 'void *', 'void *']);
// SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv)
// pszFile : LPCWSTR -> 'str16'
// dwFileAttributes : DWORD -> 'uint32_t'
// riid : GUID* -> 'void *'
// ppv : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHCreateFileExtractIconW: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv)
// pszFile : LPCWSTR -> "buffer"
// dwFileAttributes : DWORD -> "u32"
// riid : GUID* -> "pointer"
// ppv : void** out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHCreateFileExtractIconW(
    const uint16_t* pszFile,
    uint32_t dwFileAttributes,
    void* riid,
    void** ppv);
C, "SHELL32.dll");
// $ffi->SHCreateFileExtractIconW(pszFile, dwFileAttributes, riid, ppv);
// pszFile : LPCWSTR
// dwFileAttributes : DWORD
// riid : GUID*
// ppv : void** out
// 構造体/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.UNICODE_OPTIONS);
    int SHCreateFileExtractIconW(
        WString pszFile,   // LPCWSTR
        int dwFileAttributes,   // DWORD
        Pointer riid,   // GUID*
        Pointer ppv   // void** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun SHCreateFileExtractIconW = SHCreateFileExtractIconW(
    pszFile : UInt16*,   # LPCWSTR
    dwFileAttributes : UInt32,   # DWORD
    riid : GUID*,   # GUID*
    ppv : Void**   # void** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHCreateFileExtractIconWNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>);
typedef SHCreateFileExtractIconWDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>);
final SHCreateFileExtractIconW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHCreateFileExtractIconWNative, SHCreateFileExtractIconWDart>('SHCreateFileExtractIconW');
// pszFile : LPCWSTR -> Pointer<Utf16>
// dwFileAttributes : DWORD -> Uint32
// riid : GUID* -> Pointer<Void>
// ppv : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHCreateFileExtractIconW(
  pszFile: PWideChar;   // LPCWSTR
  dwFileAttributes: DWORD;   // DWORD
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHCreateFileExtractIconW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHCreateFileExtractIconW"
  c_SHCreateFileExtractIconW :: CWString -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- pszFile : LPCWSTR -> CWString
-- dwFileAttributes : DWORD -> Word32
-- riid : GUID* -> Ptr ()
-- ppv : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shcreatefileextracticonw =
  foreign "SHCreateFileExtractIconW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pszFile : LPCWSTR -> (ptr uint16_t) *)
(* dwFileAttributes : DWORD -> uint32_t *)
(* riid : GUID* -> (ptr void) *)
(* ppv : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHCreateFileExtractIconW" shcreate-file-extract-icon-w :convention :stdcall) :int32
  (psz-file (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-file-attributes :uint32)   ; DWORD
  (riid :pointer)   ; GUID*
  (ppv :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHCreateFileExtractIconW = Win32::API::More->new('SHELL32',
    'int SHCreateFileExtractIconW(LPCWSTR pszFile, DWORD dwFileAttributes, LPVOID riid, LPVOID ppv)');
# my $ret = $SHCreateFileExtractIconW->Call($pszFile, $dwFileAttributes, $riid, $ppv);
# pszFile : LPCWSTR -> LPCWSTR
# dwFileAttributes : DWORD -> DWORD
# riid : GUID* -> LPVOID
# ppv : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。