Win32 API 日本語リファレンス
ホームSystem.Ole › OleMetafilePictFromIconAndLabel

OleMetafilePictFromIconAndLabel

関数
アイコンとラベルからメタファイルピクチャを作成する。
DLLOLE32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// OLE32.dll
#include <windows.h>

HGLOBAL OleMetafilePictFromIconAndLabel(
    HICON hIcon,
    LPWSTR lpszLabel,
    LPWSTR lpszSourceFile,
    DWORD iIconIndex
);

パラメーター

名前方向説明
hIconHICONinメタファイルに描画するアイコンへのハンドルです。このパラメーターには NULL を指定できます。hIconNULL の場合、この関数はメタファイルを作成せずに NULL を返します。
lpszLabelLPWSTRinアイコンのラベルです。このパラメーターには NULL を指定できます。lpszLabelNULL の場合、生成されるメタファイルにはラベルが含まれません。
lpszSourceFileLPWSTRinアイコンファイルのパスおよびファイル名です。この文字列はユーザーインターフェイスまたは登録データベースから取得できます。このパラメーターには NULL を指定できます。
iIconIndexDWORDinlpszSourceFile で指定されたファイル内におけるアイコンの位置を、ファイルの先頭からのバイト単位のオフセットで表したものです。

戻り値の型: HGLOBAL

公式ドキュメント

指定されたアイコンとラベルが描画されたメタファイルを作成します。

戻り値

アイコンとラベルを含む METAFILEPICT 構造体へのグローバルハンドルです。このメタファイルは MM_ANISOTROPIC マッピングモードを使用します。

エラーが発生した場合、返されるハンドルは NULL になります。この場合、呼び出し側は GetLastError を呼び出して詳細情報を取得できます。

解説(Remarks)

この関数は OleGetIconOfFile および OleGetIconOfClass から呼び出されます。

lpszSourceFileNULL ではなく、かつ iIconIndex が 0 ではない場合、lpszSourceFile で渡されたソースファイルの名前と iIconIndex で渡されたインデックスが、コメントレコードとして作成されたメタファイルに追加されます。

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

各言語での呼び出し定義

// OLE32.dll
#include <windows.h>

HGLOBAL OleMetafilePictFromIconAndLabel(
    HICON hIcon,
    LPWSTR lpszLabel,
    LPWSTR lpszSourceFile,
    DWORD iIconIndex
);
[DllImport("OLE32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr OleMetafilePictFromIconAndLabel(
    IntPtr hIcon,   // HICON
    [MarshalAs(UnmanagedType.LPWStr)] string lpszLabel,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszSourceFile,   // LPWSTR
    uint iIconIndex   // DWORD
);
<DllImport("OLE32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OleMetafilePictFromIconAndLabel(
    hIcon As IntPtr,   ' HICON
    <MarshalAs(UnmanagedType.LPWStr)> lpszLabel As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszSourceFile As String,   ' LPWSTR
    iIconIndex As UInteger   ' DWORD
) As IntPtr
End Function
' hIcon : HICON
' lpszLabel : LPWSTR
' lpszSourceFile : LPWSTR
' iIconIndex : DWORD
Declare PtrSafe Function OleMetafilePictFromIconAndLabel Lib "ole32" ( _
    ByVal hIcon As LongPtr, _
    ByVal lpszLabel As LongPtr, _
    ByVal lpszSourceFile As LongPtr, _
    ByVal iIconIndex As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OleMetafilePictFromIconAndLabel = ctypes.windll.ole32.OleMetafilePictFromIconAndLabel
OleMetafilePictFromIconAndLabel.restype = ctypes.c_void_p
OleMetafilePictFromIconAndLabel.argtypes = [
    wintypes.HANDLE,  # hIcon : HICON
    wintypes.LPCWSTR,  # lpszLabel : LPWSTR
    wintypes.LPCWSTR,  # lpszSourceFile : LPWSTR
    wintypes.DWORD,  # iIconIndex : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleMetafilePictFromIconAndLabel = Fiddle::Function.new(
  lib['OleMetafilePictFromIconAndLabel'],
  [
    Fiddle::TYPE_VOIDP,  # hIcon : HICON
    Fiddle::TYPE_VOIDP,  # lpszLabel : LPWSTR
    Fiddle::TYPE_VOIDP,  # lpszSourceFile : LPWSTR
    -Fiddle::TYPE_INT,  # iIconIndex : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "ole32")]
extern "system" {
    fn OleMetafilePictFromIconAndLabel(
        hIcon: *mut core::ffi::c_void,  // HICON
        lpszLabel: *mut u16,  // LPWSTR
        lpszSourceFile: *mut u16,  // LPWSTR
        iIconIndex: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll", SetLastError = true)]
public static extern IntPtr OleMetafilePictFromIconAndLabel(IntPtr hIcon, [MarshalAs(UnmanagedType.LPWStr)] string lpszLabel, [MarshalAs(UnmanagedType.LPWStr)] string lpszSourceFile, uint iIconIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleMetafilePictFromIconAndLabel' -Namespace Win32 -PassThru
# $api::OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex)
#uselib "OLE32.dll"
#func global OleMetafilePictFromIconAndLabel "OleMetafilePictFromIconAndLabel" sptr, sptr, sptr, sptr
; OleMetafilePictFromIconAndLabel hIcon, lpszLabel, lpszSourceFile, iIconIndex   ; 戻り値は stat
; hIcon : HICON -> "sptr"
; lpszLabel : LPWSTR -> "sptr"
; lpszSourceFile : LPWSTR -> "sptr"
; iIconIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLE32.dll"
#cfunc global OleMetafilePictFromIconAndLabel "OleMetafilePictFromIconAndLabel" sptr, wstr, wstr, int
; res = OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex)
; hIcon : HICON -> "sptr"
; lpszLabel : LPWSTR -> "wstr"
; lpszSourceFile : LPWSTR -> "wstr"
; iIconIndex : DWORD -> "int"
; HGLOBAL OleMetafilePictFromIconAndLabel(HICON hIcon, LPWSTR lpszLabel, LPWSTR lpszSourceFile, DWORD iIconIndex)
#uselib "OLE32.dll"
#cfunc global OleMetafilePictFromIconAndLabel "OleMetafilePictFromIconAndLabel" intptr, wstr, wstr, int
; res = OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex)
; hIcon : HICON -> "intptr"
; lpszLabel : LPWSTR -> "wstr"
; lpszSourceFile : LPWSTR -> "wstr"
; iIconIndex : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleMetafilePictFromIconAndLabel = ole32.NewProc("OleMetafilePictFromIconAndLabel")
)

// hIcon (HICON), lpszLabel (LPWSTR), lpszSourceFile (LPWSTR), iIconIndex (DWORD)
r1, _, err := procOleMetafilePictFromIconAndLabel.Call(
	uintptr(hIcon),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszLabel))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszSourceFile))),
	uintptr(iIconIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HGLOBAL
function OleMetafilePictFromIconAndLabel(
  hIcon: THandle;   // HICON
  lpszLabel: PWideChar;   // LPWSTR
  lpszSourceFile: PWideChar;   // LPWSTR
  iIconIndex: DWORD   // DWORD
): THandle; stdcall;
  external 'OLE32.dll' name 'OleMetafilePictFromIconAndLabel';
result := DllCall("OLE32\OleMetafilePictFromIconAndLabel"
    , "Ptr", hIcon   ; HICON
    , "WStr", lpszLabel   ; LPWSTR
    , "WStr", lpszSourceFile   ; LPWSTR
    , "UInt", iIconIndex   ; DWORD
    , "Ptr")   ; return: HGLOBAL
●OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex) = DLL("OLE32.dll", "void* OleMetafilePictFromIconAndLabel(void*, char*, char*, dword)")
# 呼び出し: OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex)
# hIcon : HICON -> "void*"
# lpszLabel : LPWSTR -> "char*"
# lpszSourceFile : LPWSTR -> "char*"
# iIconIndex : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ole32" fn OleMetafilePictFromIconAndLabel(
    hIcon: ?*anyopaque, // HICON
    lpszLabel: [*c]const u16, // LPWSTR
    lpszSourceFile: [*c]const u16, // LPWSTR
    iIconIndex: u32 // DWORD
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc OleMetafilePictFromIconAndLabel(
    hIcon: pointer,  # HICON
    lpszLabel: WideCString,  # LPWSTR
    lpszSourceFile: WideCString,  # LPWSTR
    iIconIndex: uint32  # DWORD
): pointer {.importc: "OleMetafilePictFromIconAndLabel", stdcall, dynlib: "OLE32.dll".}
pragma(lib, "ole32");
extern(Windows)
void* OleMetafilePictFromIconAndLabel(
    void* hIcon,   // HICON
    const(wchar)* lpszLabel,   // LPWSTR
    const(wchar)* lpszSourceFile,   // LPWSTR
    uint iIconIndex   // DWORD
);
ccall((:OleMetafilePictFromIconAndLabel, "OLE32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cwstring, Cwstring, UInt32),
      hIcon, lpszLabel, lpszSourceFile, iIconIndex)
# hIcon : HICON -> Ptr{Cvoid}
# lpszLabel : LPWSTR -> Cwstring
# lpszSourceFile : LPWSTR -> Cwstring
# iIconIndex : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* OleMetafilePictFromIconAndLabel(
    void* hIcon,
    const uint16_t* lpszLabel,
    const uint16_t* lpszSourceFile,
    uint32_t iIconIndex);
]]
local ole32 = ffi.load("ole32")
-- ole32.OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex)
-- hIcon : HICON
-- lpszLabel : LPWSTR
-- lpszSourceFile : LPWSTR
-- iIconIndex : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const OleMetafilePictFromIconAndLabel = lib.func('__stdcall', 'OleMetafilePictFromIconAndLabel', 'void *', ['void *', 'str16', 'str16', 'uint32_t']);
// OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex)
// hIcon : HICON -> 'void *'
// lpszLabel : LPWSTR -> 'str16'
// lpszSourceFile : LPWSTR -> 'str16'
// iIconIndex : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLE32.dll", {
  OleMetafilePictFromIconAndLabel: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex)
// hIcon : HICON -> "pointer"
// lpszLabel : LPWSTR -> "buffer"
// lpszSourceFile : LPWSTR -> "buffer"
// iIconIndex : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* OleMetafilePictFromIconAndLabel(
    void* hIcon,
    const uint16_t* lpszLabel,
    const uint16_t* lpszSourceFile,
    uint32_t iIconIndex);
C, "OLE32.dll");
// $ffi->OleMetafilePictFromIconAndLabel(hIcon, lpszLabel, lpszSourceFile, iIconIndex);
// hIcon : HICON
// lpszLabel : LPWSTR
// lpszSourceFile : LPWSTR
// iIconIndex : 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 Ole32 extends StdCallLibrary {
    Ole32 INSTANCE = Native.load("ole32", Ole32.class);
    Pointer OleMetafilePictFromIconAndLabel(
        Pointer hIcon,   // HICON
        WString lpszLabel,   // LPWSTR
        WString lpszSourceFile,   // LPWSTR
        int iIconIndex   // DWORD
    );
}
@[Link("ole32")]
lib LibOLE32
  fun OleMetafilePictFromIconAndLabel = OleMetafilePictFromIconAndLabel(
    hIcon : Void*,   # HICON
    lpszLabel : UInt16*,   # LPWSTR
    lpszSourceFile : UInt16*,   # LPWSTR
    iIconIndex : UInt32   # DWORD
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OleMetafilePictFromIconAndLabelNative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef OleMetafilePictFromIconAndLabelDart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final OleMetafilePictFromIconAndLabel = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<OleMetafilePictFromIconAndLabelNative, OleMetafilePictFromIconAndLabelDart>('OleMetafilePictFromIconAndLabel');
// hIcon : HICON -> Pointer<Void>
// lpszLabel : LPWSTR -> Pointer<Utf16>
// lpszSourceFile : LPWSTR -> Pointer<Utf16>
// iIconIndex : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleMetafilePictFromIconAndLabel(
  hIcon: THandle;   // HICON
  lpszLabel: PWideChar;   // LPWSTR
  lpszSourceFile: PWideChar;   // LPWSTR
  iIconIndex: DWORD   // DWORD
): THandle; stdcall;
  external 'OLE32.dll' name 'OleMetafilePictFromIconAndLabel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleMetafilePictFromIconAndLabel"
  c_OleMetafilePictFromIconAndLabel :: Ptr () -> CWString -> CWString -> Word32 -> IO (Ptr ())
-- hIcon : HICON -> Ptr ()
-- lpszLabel : LPWSTR -> CWString
-- lpszSourceFile : LPWSTR -> CWString
-- iIconIndex : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let olemetafilepictfromiconandlabel =
  foreign "OleMetafilePictFromIconAndLabel"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning (ptr void))
(* hIcon : HICON -> (ptr void) *)
(* lpszLabel : LPWSTR -> (ptr uint16_t) *)
(* lpszSourceFile : LPWSTR -> (ptr uint16_t) *)
(* iIconIndex : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("OleMetafilePictFromIconAndLabel" ole-metafile-pict-from-icon-and-label :convention :stdcall) :pointer
  (h-icon :pointer)   ; HICON
  (lpsz-label (:string :encoding :utf-16le))   ; LPWSTR
  (lpsz-source-file (:string :encoding :utf-16le))   ; LPWSTR
  (i-icon-index :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleMetafilePictFromIconAndLabel = Win32::API::More->new('OLE32',
    'HANDLE OleMetafilePictFromIconAndLabel(HANDLE hIcon, LPCWSTR lpszLabel, LPCWSTR lpszSourceFile, DWORD iIconIndex)');
# my $ret = $OleMetafilePictFromIconAndLabel->Call($hIcon, $lpszLabel, $lpszSourceFile, $iIconIndex);
# hIcon : HICON -> HANDLE
# lpszLabel : LPWSTR -> LPCWSTR
# lpszSourceFile : LPWSTR -> LPCWSTR
# iIconIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目