ホーム › UI.WindowsAndMessaging › GetIconInfoExA

GetIconInfoExA

関数

アイコンの拡張情報を取得する(ANSI版)。

DLLUSER32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetIconInfoExA(
    HICON hicon,
    ICONINFOEXA* piconinfo
);

パラメーター

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

名前

型

方向

説明

hicon

HICON

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

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

piconinfo

ICONINFOEXA*

inout

このメソッドが返るとき、ICONINFOEX 構造体へのポインターが格納されます。この関数は構造体のメンバーを設定します。

戻り値の型: BOOL

公式ドキュメント

指定したアイコンまたはカーソルに関する情報を取得します。GetIconInfoEx は、より新しい ICONINFOEX 構造体を使用することで GetIconInfo を拡張したものです。(ANSI)

戻り値

型: BOOL

TRUE は成功を、FALSE は失敗を示します。

解説(Remarks)

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

DPI 仮想化

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

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンと Unicode バージョンを自動的に選択するエイリアスとして GetIconInfoEx を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不整合が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetIconInfoExA(
    HICON hicon,
    ICONINFOEXA* piconinfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool GetIconInfoExA(
    IntPtr hicon,   // HICON
    IntPtr piconinfo   // ICONINFOEXA* in/out
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetIconInfoExA(
    hicon As IntPtr,   ' HICON
    piconinfo As IntPtr   ' ICONINFOEXA* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hicon : HICON
' piconinfo : ICONINFOEXA* in/out
Declare PtrSafe Function GetIconInfoExA 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

GetIconInfoExA = ctypes.windll.user32.GetIconInfoExA
GetIconInfoExA.restype = wintypes.BOOL
GetIconInfoExA.argtypes = [
    wintypes.HANDLE,  # hicon : HICON
    ctypes.c_void_p,  # piconinfo : ICONINFOEXA* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetIconInfoExA = Fiddle::Function.new(
  lib['GetIconInfoExA'],
  [
    Fiddle::TYPE_VOIDP,  # hicon : HICON
    Fiddle::TYPE_VOIDP,  # piconinfo : ICONINFOEXA* in/out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern bool GetIconInfoExA(IntPtr hicon, IntPtr piconinfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetIconInfoExA' -Namespace Win32 -PassThru
# $api::GetIconInfoExA(hicon, piconinfo)

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

出力引数:

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