OleGetIconOfClass

関数

指定CLSIDのクラスに関連付けられたアイコンを取得する。

DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HGLOBAL OleGetIconOfClass(
    const GUID* rclsid,
    LPWSTR lpszLabel,   // optional
    BOOL fUseTypeAsLabel
);

パラメーター

名前	型	方向	説明
rclsid	GUID*	in	アイコンと文字列を要求する対象の CLSID。
lpszLabel	LPWSTR	inoptional	アイコンのラベルへのポインター。
fUseTypeAsLabel	BOOL	in	CLSID 内のユーザー型文字列をアイコンのラベルとして使用するかどうかを示します。

戻り値の型: HGLOBAL

公式ドキュメント

指定した CLSID のアイコンと文字列ラベルを含むメタファイルへのハンドルを返します。

戻り値

関数が成功した場合、戻り値は指定した CLSID のアイコンとラベルを含むメタファイルへのハンドルです。それ以外の場合、関数は NULL を返します。

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

各言語での呼び出し定義

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

HGLOBAL OleGetIconOfClass(
    const GUID* rclsid,
    LPWSTR lpszLabel,   // optional
    BOOL fUseTypeAsLabel
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern IntPtr OleGetIconOfClass(
    ref Guid rclsid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] string lpszLabel,   // LPWSTR optional
    bool fUseTypeAsLabel   // BOOL
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleGetIconOfClass(
    ByRef rclsid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> lpszLabel As String,   ' LPWSTR optional
    fUseTypeAsLabel As Boolean   ' BOOL
) As IntPtr
End Function

' rclsid : GUID*
' lpszLabel : LPWSTR optional
' fUseTypeAsLabel : BOOL
Declare PtrSafe Function OleGetIconOfClass Lib "ole32" ( _
    ByVal rclsid As LongPtr, _
    ByVal lpszLabel As LongPtr, _
    ByVal fUseTypeAsLabel As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleGetIconOfClass = ctypes.windll.ole32.OleGetIconOfClass
OleGetIconOfClass.restype = ctypes.c_void_p
OleGetIconOfClass.argtypes = [
    ctypes.c_void_p,  # rclsid : GUID*
    wintypes.LPCWSTR,  # lpszLabel : LPWSTR optional
    wintypes.BOOL,  # fUseTypeAsLabel : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleGetIconOfClass = Fiddle::Function.new(
  lib['OleGetIconOfClass'],
  [
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
    Fiddle::TYPE_VOIDP,  # lpszLabel : LPWSTR optional
    Fiddle::TYPE_INT,  # fUseTypeAsLabel : BOOL
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "ole32")]
extern "system" {
    fn OleGetIconOfClass(
        rclsid: *const GUID,  // GUID*
        lpszLabel: *mut u16,  // LPWSTR optional
        fUseTypeAsLabel: i32  // BOOL
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern IntPtr OleGetIconOfClass(ref Guid rclsid, [MarshalAs(UnmanagedType.LPWStr)] string lpszLabel, bool fUseTypeAsLabel);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleGetIconOfClass' -Namespace Win32 -PassThru
# $api::OleGetIconOfClass(rclsid, lpszLabel, fUseTypeAsLabel)

#uselib "OLE32.dll"
#func global OleGetIconOfClass "OleGetIconOfClass" sptr, sptr, sptr
; OleGetIconOfClass varptr(rclsid), lpszLabel, fUseTypeAsLabel   ; 戻り値は stat
; rclsid : GUID* -> "sptr"
; lpszLabel : LPWSTR optional -> "sptr"
; fUseTypeAsLabel : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global OleGetIconOfClass "OleGetIconOfClass" var, wstr, int
; res = OleGetIconOfClass(rclsid, lpszLabel, fUseTypeAsLabel)
; rclsid : GUID* -> "var"
; lpszLabel : LPWSTR optional -> "wstr"
; fUseTypeAsLabel : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global OleGetIconOfClass "OleGetIconOfClass" sptr, wstr, int
; res = OleGetIconOfClass(varptr(rclsid), lpszLabel, fUseTypeAsLabel)
; rclsid : GUID* -> "sptr"
; lpszLabel : LPWSTR optional -> "wstr"
; fUseTypeAsLabel : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。