ホーム › UI.WindowsAndMessaging › GetIconInfo

GetIconInfo

関数

アイコンまたはカーソルの情報を取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetIconInfo(
    HICON hIcon,
    ICONINFO* piconinfo
);

パラメーター

名前	型	方向	説明
hIcon	HICON	in	アイコンまたはカーソルのハンドル。標準アイコンまたは標準カーソルに関する情報を取得するには、このパラメーターに IDI_ プレフィックスで始まる識別子または IDC_ プレフィックスで始まる識別子を指定します。
piconinfo	ICONINFO*	out	ICONINFO 構造体へのポインター。関数はこの構造体のメンバーを設定します。

名前

型

方向

説明

hIcon

HICON

アイコンまたはカーソルのハンドル。

標準アイコンまたは標準カーソルに関する情報を取得するには、このパラメーターに IDI_ プレフィックスで始まる識別子または IDC_ プレフィックスで始まる識別子を指定します。

piconinfo

ICONINFO*

out

ICONINFO 構造体へのポインター。関数はこの構造体のメンバーを設定します。

戻り値の型: BOOL

公式ドキュメント

指定したアイコンまたはカーソルに関する情報を取得します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外になり、指定した ICONINFO 構造体のメンバーが設定されます。

関数が失敗すると、戻り値は 0 になります。詳細なエラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

GetIconInfo は、ICONINFO の hbmMask メンバーおよび hbmColor メンバー用のビットマップを作成します。呼び出し側のアプリケーションは、これらのビットマップを管理し、不要になった時点で DeleteObject を呼び出して削除する必要があります。

DPI 仮想化

この API は DPI 仮想化に対応していません。返される出力は、呼び出し側スレッドの DPI の影響を受けません。

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

各言語での呼び出し定義

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

BOOL GetIconInfo(
    HICON hIcon,
    ICONINFO* piconinfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetIconInfo(
    IntPtr hIcon,   // HICON
    IntPtr piconinfo   // ICONINFO* out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetIconInfo(
    hIcon As IntPtr,   ' HICON
    piconinfo As IntPtr   ' ICONINFO* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hIcon : HICON
' piconinfo : ICONINFO* out
Declare PtrSafe Function GetIconInfo Lib "user32" ( _
    ByVal hIcon As LongPtr, _
    ByVal piconinfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetIconInfo = ctypes.windll.user32.GetIconInfo
GetIconInfo.restype = wintypes.BOOL
GetIconInfo.argtypes = [
    wintypes.HANDLE,  # hIcon : HICON
    ctypes.c_void_p,  # piconinfo : ICONINFO* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetIconInfo = Fiddle::Function.new(
  lib['GetIconInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hIcon : HICON
    Fiddle::TYPE_VOIDP,  # piconinfo : ICONINFO* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetIconInfo(
        hIcon: *mut core::ffi::c_void,  // HICON
        piconinfo: *mut ICONINFO  // ICONINFO* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetIconInfo(IntPtr hIcon, IntPtr piconinfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetIconInfo' -Namespace Win32 -PassThru
# $api::GetIconInfo(hIcon, piconinfo)

#uselib "USER32.dll"
#func global GetIconInfo "GetIconInfo" sptr, sptr
; GetIconInfo hIcon, varptr(piconinfo)   ; 戻り値は stat
; hIcon : HICON -> "sptr"
; piconinfo : ICONINFO* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetIconInfo "GetIconInfo" sptr, var
; res = GetIconInfo(hIcon, piconinfo)
; hIcon : HICON -> "sptr"
; piconinfo : ICONINFO* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetIconInfo "GetIconInfo" sptr, sptr
; res = GetIconInfo(hIcon, varptr(piconinfo))
; hIcon : HICON -> "sptr"
; piconinfo : ICONINFO* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。