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

GetAncestor

関数
指定ウィンドウの親や先祖ウィンドウのハンドルを取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HWND GetAncestor(
    HWND hwnd,
    GET_ANCESTOR_FLAGS gaFlags
);

パラメーター

名前方向説明
hwndHWNDin祖先を取得する対象ウィンドウのハンドルです。このパラメーターがデスクトップウィンドウの場合、この関数は NULL を返します。
gaFlagsGET_ANCESTOR_FLAGSin

取得する祖先を指定します。このパラメーターには次のいずれかの値を指定できます。

Value Meaning
GA_PARENT
1
親ウィンドウを取得します。GetParent 関数の場合とは異なり、オーナーは含まれません。
GA_ROOT
2
親ウィンドウのチェーンをたどってルートウィンドウを取得します。
GA_ROOTOWNER
3
GetParent が返す親ウィンドウとオーナーウィンドウのチェーンをたどって、オーナーを持つルートウィンドウを取得します。

戻り値の型: HWND

公式ドキュメント

指定したウィンドウの祖先ウィンドウのハンドルを取得します。

戻り値

Type: HWND

戻り値は祖先ウィンドウのハンドルです。

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

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

各言語での呼び出し定義

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

HWND GetAncestor(
    HWND hwnd,
    GET_ANCESTOR_FLAGS gaFlags
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr GetAncestor(
    IntPtr hwnd,   // HWND
    uint gaFlags   // GET_ANCESTOR_FLAGS
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetAncestor(
    hwnd As IntPtr,   ' HWND
    gaFlags As UInteger   ' GET_ANCESTOR_FLAGS
) As IntPtr
End Function
' hwnd : HWND
' gaFlags : GET_ANCESTOR_FLAGS
Declare PtrSafe Function GetAncestor Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal gaFlags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetAncestor = ctypes.windll.user32.GetAncestor
GetAncestor.restype = ctypes.c_void_p
GetAncestor.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    wintypes.DWORD,  # gaFlags : GET_ANCESTOR_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetAncestor = user32.NewProc("GetAncestor")
)

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

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

typedef GetAncestorNative = Pointer<Void> Function(Pointer<Void>, Uint32);
typedef GetAncestorDart = Pointer<Void> Function(Pointer<Void>, int);
final GetAncestor = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetAncestorNative, GetAncestorDart>('GetAncestor');
// hwnd : HWND -> Pointer<Void>
// gaFlags : GET_ANCESTOR_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetAncestor(
  hwnd: THandle;   // HWND
  gaFlags: DWORD   // GET_ANCESTOR_FLAGS
): THandle; stdcall;
  external 'USER32.dll' name 'GetAncestor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetAncestor"
  c_GetAncestor :: Ptr () -> Word32 -> IO (Ptr ())
-- hwnd : HWND -> Ptr ()
-- gaFlags : GET_ANCESTOR_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getancestor =
  foreign "GetAncestor"
    ((ptr void) @-> uint32_t @-> returning (ptr void))
(* hwnd : HWND -> (ptr void) *)
(* gaFlags : GET_ANCESTOR_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetAncestor" get-ancestor :convention :stdcall) :pointer
  (hwnd :pointer)   ; HWND
  (ga-flags :uint32))   ; GET_ANCESTOR_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetAncestor = Win32::API::More->new('USER32',
    'HANDLE GetAncestor(HANDLE hwnd, DWORD gaFlags)');
# my $ret = $GetAncestor->Call($hwnd, $gaFlags);
# hwnd : HWND -> HANDLE
# gaFlags : GET_ANCESTOR_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型