GetComboBoxInfo

関数

コンボボックスの内部構成情報を取得する。

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

シグネチャ

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

BOOL GetComboBoxInfo(
    HWND hwndCombo,
    COMBOBOXINFO* pcbi
);

パラメーター

名前	型	方向	説明
hwndCombo	HWND	in	コンボボックスへのハンドルです。
pcbi	COMBOBOXINFO*	inout	情報を受け取る COMBOBOXINFO 構造体へのポインターです。この関数を呼び出す前に、COMBOBOXINFO.cbSize を設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

指定したコンボボックスに関する情報を取得します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

CB_GETCOMBOBOXINFO メッセージはこの関数と同等です。

例

次のコード例では、ウィンドウハンドルで指定したコンボボックスに関する情報を取得します。

COMBOBOXINFO info = { sizeof(COMBOBOXINFO) };
GetComboBoxInfo(hwnd, &info);

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

各言語での呼び出し定義

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

BOOL GetComboBoxInfo(
    HWND hwndCombo,
    COMBOBOXINFO* pcbi
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetComboBoxInfo(
    IntPtr hwndCombo,   // HWND
    IntPtr pcbi   // COMBOBOXINFO* in/out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetComboBoxInfo(
    hwndCombo As IntPtr,   ' HWND
    pcbi As IntPtr   ' COMBOBOXINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwndCombo : HWND
' pcbi : COMBOBOXINFO* in/out
Declare PtrSafe Function GetComboBoxInfo Lib "user32" ( _
    ByVal hwndCombo As LongPtr, _
    ByVal pcbi As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetComboBoxInfo = ctypes.windll.user32.GetComboBoxInfo
GetComboBoxInfo.restype = wintypes.BOOL
GetComboBoxInfo.argtypes = [
    wintypes.HANDLE,  # hwndCombo : HWND
    ctypes.c_void_p,  # pcbi : COMBOBOXINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetComboBoxInfo = Fiddle::Function.new(
  lib['GetComboBoxInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hwndCombo : HWND
    Fiddle::TYPE_VOIDP,  # pcbi : COMBOBOXINFO* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetComboBoxInfo(
        hwndCombo: *mut core::ffi::c_void,  // HWND
        pcbi: *mut COMBOBOXINFO  // COMBOBOXINFO* in/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 GetComboBoxInfo(IntPtr hwndCombo, IntPtr pcbi);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetComboBoxInfo' -Namespace Win32 -PassThru
# $api::GetComboBoxInfo(hwndCombo, pcbi)

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

出力引数:

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