Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › GetNextDlgGroupItem

GetNextDlgGroupItem

関数
グループ内の前後のコントロールを取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HWND GetNextDlgGroupItem(
    HWND hDlg,
    HWND hCtl,   // optional
    BOOL bPrevious
);

パラメーター

名前方向説明
hDlgHWNDin検索対象となるダイアログボックスのハンドルです。
hCtlHWNDinoptional検索の起点として使用するコントロールのハンドルです。このパラメーターが NULL の場合、関数はダイアログボックス内の最後(または最初)のコントロールを検索の起点として使用します。
bPreviousBOOLin関数がダイアログボックス内のコントロールグループをどのように検索するかを示します。このパラメーターが TRUE の場合、関数はグループ内の前のコントロールを検索します。FALSE の場合、関数はグループ内の次のコントロールを検索します。

戻り値の型: HWND

公式ドキュメント

ダイアログボックス内で、指定したコントロールの前(または後ろ)にあるコントロールグループの最初のコントロールのハンドルを取得します。

戻り値

型: HWND

関数が成功した場合、戻り値はコントロールグループ内の前(または次)のコントロールのハンドルです。

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

解説(Remarks)

GetNextDlgGroupItem 関数は、ダイアログボックステンプレート内でコントロールが作成された順序(または逆順)で検索します。グループ内の最初のコントロールには WS_GROUP スタイルが設定されている必要があります。グループ内の他のすべてのコントロールは連続して作成されている必要があり、WS_GROUP スタイルを持っていてはなりません。

前のコントロールを検索する場合、関数は表示されており無効化されていない最初のコントロールを見つけて返します。hCtl で指定されたコントロールが WS_GROUP スタイルを持つ場合、関数は一時的に検索方向を反転して WS_GROUP スタイルを持つ最初のコントロールを探し、その後元の方向で検索を再開して、表示されており無効化されていない最初のコントロールを返します。そのようなコントロールが見つからない場合は hCtl を返します。

次のコントロールを検索する場合、関数は表示されており、無効化されておらず、WS_GROUP スタイルを持たない最初のコントロールを見つけて返します。WS_GROUP スタイルを持つコントロールに遭遇した場合、関数は検索方向を反転して WS_GROUP スタイルを持つ最初のコントロールを探し、それが表示されており無効化されていない場合はそのコントロールを返します。そうでない場合、関数は元の方向で検索を再開し、表示されており無効化されていない最初のコントロールを返します。そのようなコントロールが見つからない場合は hCtl を返します。

グループ内の次のコントロールを検索中に WS_EX_CONTROLPARENT スタイルを持つウィンドウに遭遇した場合、システムはそのウィンドウの子コントロールを再帰的に検索します。

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

各言語での呼び出し定義

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

HWND GetNextDlgGroupItem(
    HWND hDlg,
    HWND hCtl,   // optional
    BOOL bPrevious
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr GetNextDlgGroupItem(
    IntPtr hDlg,   // HWND
    IntPtr hCtl,   // HWND optional
    bool bPrevious   // BOOL
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNextDlgGroupItem(
    hDlg As IntPtr,   ' HWND
    hCtl As IntPtr,   ' HWND optional
    bPrevious As Boolean   ' BOOL
) As IntPtr
End Function
' hDlg : HWND
' hCtl : HWND optional
' bPrevious : BOOL
Declare PtrSafe Function GetNextDlgGroupItem Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal hCtl As LongPtr, _
    ByVal bPrevious As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetNextDlgGroupItem = ctypes.windll.user32.GetNextDlgGroupItem
GetNextDlgGroupItem.restype = ctypes.c_void_p
GetNextDlgGroupItem.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    wintypes.HANDLE,  # hCtl : HWND optional
    wintypes.BOOL,  # bPrevious : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetNextDlgGroupItem = Fiddle::Function.new(
  lib['GetNextDlgGroupItem'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_VOIDP,  # hCtl : HWND optional
    Fiddle::TYPE_INT,  # bPrevious : BOOL
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn GetNextDlgGroupItem(
        hDlg: *mut core::ffi::c_void,  // HWND
        hCtl: *mut core::ffi::c_void,  // HWND optional
        bPrevious: i32  // BOOL
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern IntPtr GetNextDlgGroupItem(IntPtr hDlg, IntPtr hCtl, bool bPrevious);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetNextDlgGroupItem' -Namespace Win32 -PassThru
# $api::GetNextDlgGroupItem(hDlg, hCtl, bPrevious)
#uselib "USER32.dll"
#func global GetNextDlgGroupItem "GetNextDlgGroupItem" sptr, sptr, sptr
; GetNextDlgGroupItem hDlg, hCtl, bPrevious   ; 戻り値は stat
; hDlg : HWND -> "sptr"
; hCtl : HWND optional -> "sptr"
; bPrevious : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetNextDlgGroupItem "GetNextDlgGroupItem" sptr, sptr, int
; res = GetNextDlgGroupItem(hDlg, hCtl, bPrevious)
; hDlg : HWND -> "sptr"
; hCtl : HWND optional -> "sptr"
; bPrevious : BOOL -> "int"
; HWND GetNextDlgGroupItem(HWND hDlg, HWND hCtl, BOOL bPrevious)
#uselib "USER32.dll"
#cfunc global GetNextDlgGroupItem "GetNextDlgGroupItem" intptr, intptr, int
; res = GetNextDlgGroupItem(hDlg, hCtl, bPrevious)
; hDlg : HWND -> "intptr"
; hCtl : HWND optional -> "intptr"
; bPrevious : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetNextDlgGroupItem = user32.NewProc("GetNextDlgGroupItem")
)

// hDlg (HWND), hCtl (HWND optional), bPrevious (BOOL)
r1, _, err := procGetNextDlgGroupItem.Call(
	uintptr(hDlg),
	uintptr(hCtl),
	uintptr(bPrevious),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HWND
function GetNextDlgGroupItem(
  hDlg: THandle;   // HWND
  hCtl: THandle;   // HWND optional
  bPrevious: BOOL   // BOOL
): THandle; stdcall;
  external 'USER32.dll' name 'GetNextDlgGroupItem';
result := DllCall("USER32\GetNextDlgGroupItem"
    , "Ptr", hDlg   ; HWND
    , "Ptr", hCtl   ; HWND optional
    , "Int", bPrevious   ; BOOL
    , "Ptr")   ; return: HWND
●GetNextDlgGroupItem(hDlg, hCtl, bPrevious) = DLL("USER32.dll", "void* GetNextDlgGroupItem(void*, void*, bool)")
# 呼び出し: GetNextDlgGroupItem(hDlg, hCtl, bPrevious)
# hDlg : HWND -> "void*"
# hCtl : HWND optional -> "void*"
# bPrevious : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetNextDlgGroupItemNative = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, Int32);
typedef GetNextDlgGroupItemDart = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, int);
final GetNextDlgGroupItem = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetNextDlgGroupItemNative, GetNextDlgGroupItemDart>('GetNextDlgGroupItem');
// hDlg : HWND -> Pointer<Void>
// hCtl : HWND optional -> Pointer<Void>
// bPrevious : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetNextDlgGroupItem(
  hDlg: THandle;   // HWND
  hCtl: THandle;   // HWND optional
  bPrevious: BOOL   // BOOL
): THandle; stdcall;
  external 'USER32.dll' name 'GetNextDlgGroupItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetNextDlgGroupItem"
  c_GetNextDlgGroupItem :: Ptr () -> Ptr () -> CInt -> IO (Ptr ())
-- hDlg : HWND -> Ptr ()
-- hCtl : HWND optional -> Ptr ()
-- bPrevious : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getnextdlggroupitem =
  foreign "GetNextDlgGroupItem"
    ((ptr void) @-> (ptr void) @-> int32_t @-> returning (ptr void))
(* hDlg : HWND -> (ptr void) *)
(* hCtl : HWND optional -> (ptr void) *)
(* bPrevious : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetNextDlgGroupItem" get-next-dlg-group-item :convention :stdcall) :pointer
  (h-dlg :pointer)   ; HWND
  (h-ctl :pointer)   ; HWND optional
  (b-previous :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetNextDlgGroupItem = Win32::API::More->new('USER32',
    'HANDLE GetNextDlgGroupItem(HANDLE hDlg, HANDLE hCtl, BOOL bPrevious)');
# my $ret = $GetNextDlgGroupItem->Call($hDlg, $hCtl, $bPrevious);
# hDlg : HWND -> HANDLE
# hCtl : HWND optional -> HANDLE
# bPrevious : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目