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

DPA_Merge

関数
二つの動的ポインタ配列を比較関数を用いて統合する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

BOOL DPA_Merge(
    HDPA hdpaDest,
    HDPA hdpaSrc,
    DWORD dwFlags,
    PFNDACOMPARE pfnCompare,
    PFNDPAMERGE pfnMerge,
    LPARAM lParam
);

パラメーター

名前方向説明
hdpaDestHDPAin1 つ目の DPA へのハンドル。この配列は事前にソートしておくこともできます。この関数が返るとき、結合された配列へのハンドルが格納されます。
hdpaSrcHDPAin2 つ目の DPA へのハンドル。この配列は事前にソートしておくこともできます。
dwFlagsDWORDin

2 つの配列を結合する方法を決定するオプション。DPAM_NORMALDPAM_UNIONDPAM_UNION は相互に排他的であり、これらのフラグのうち 1 つだけを設定できます。必要に応じて DPAM_SORTED と組み合わせることができます。

意味
DPAM_SORTED
0x00000001
配列は事前にソートされています。ソートをスキップします。このフラグが設定されていない場合、配列は結合される前にソートされます。
DPAM_NORMAL
0x00000002
最終的な配列は、もともと hdpaDest に存在していたすべての要素で構成されます。それらの要素のいずれかが hdpaSrc にも存在する場合、それらの要素は最終的な配列内で結合されます。PFNDPAMERGE コールバック関数が DPAMM_MERGE メッセージとともに呼び出されます。

このフラグが設定されている場合、hdpaDest の配列の最終的なサイズはその初期サイズと同じになります。

DPAM_UNION
0x00000004
最終的な配列は、両方の配列のすべての要素の和集合になります。両方の配列で見つかった要素は最終的な配列内で結合されます。一方の配列のみで見つかった要素は、見つかったとおりに追加されます。このフラグが設定されている場合、PFNDPAMERGE コールバック関数は DPAMM_MERGE または DPAMM_INSERT メッセージとともに呼び出されることがあります。

最終的な配列のサイズは、少なくとも hdpaDesthdpaSrc の大きい方のサイズになり、最大でも両者の合計になります。

DPAM_INTERSECT
0x00000008
hdpaSrchdpaDest の両方で見つかった要素のみが結合されて最終的な配列を形成します。このフラグが設定されている場合、PFNDPAMERGE コールバック関数は DPAMM_MERGE または DPAMM_DELETE メッセージとともに呼び出されることがあります。

最終的な配列のサイズは、0 から hdpaDesthdpaSrc の小さい方までの範囲になります。

pfnComparePFNDACOMPAREin2 つの要素 (各 DPA から 1 つずつ) を比較し、それらが同じ項目かどうかを判定する PFNDPACOMPARE コールバック関数。同じ項目である場合、pfnCompare が指すコールバック関数が呼び出されます。
pfnMergePFNDPAMERGEinある要素が両方の DPA で見つかり、PFNDPACOMPARE によって同じ項目であると判定された場合に、その内容を結合する PFNDPAMERGE コールバック関数。
lParamLPARAMin等価性を判定する際の比較の基準を宣言するために使用される追加のパラメーター。

戻り値の型: BOOL

公式ドキュメント

2 つの動的ポインター配列 (DPA) の内容を結合します。

戻り値

型: BOOL

成功した場合は TRUE、それ以外の場合は FALSE

解説(Remarks)

DPA_Merge は名前ではエクスポートされていません。これを使用するには、GetProcAddress を使用し、ComCtl32.dll から序数 11 を要求して関数ポインターを取得する必要があります。

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

各言語での呼び出し定義

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

BOOL DPA_Merge(
    HDPA hdpaDest,
    HDPA hdpaSrc,
    DWORD dwFlags,
    PFNDACOMPARE pfnCompare,
    PFNDPAMERGE pfnMerge,
    LPARAM lParam
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern bool DPA_Merge(
    IntPtr hdpaDest,   // HDPA
    IntPtr hdpaSrc,   // HDPA
    uint dwFlags,   // DWORD
    IntPtr pfnCompare,   // PFNDACOMPARE
    IntPtr pfnMerge,   // PFNDPAMERGE
    IntPtr lParam   // LPARAM
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function DPA_Merge(
    hdpaDest As IntPtr,   ' HDPA
    hdpaSrc As IntPtr,   ' HDPA
    dwFlags As UInteger,   ' DWORD
    pfnCompare As IntPtr,   ' PFNDACOMPARE
    pfnMerge As IntPtr,   ' PFNDPAMERGE
    lParam As IntPtr   ' LPARAM
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hdpaDest : HDPA
' hdpaSrc : HDPA
' dwFlags : DWORD
' pfnCompare : PFNDACOMPARE
' pfnMerge : PFNDPAMERGE
' lParam : LPARAM
Declare PtrSafe Function DPA_Merge Lib "comctl32" ( _
    ByVal hdpaDest As LongPtr, _
    ByVal hdpaSrc As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pfnCompare As LongPtr, _
    ByVal pfnMerge As LongPtr, _
    ByVal lParam As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DPA_Merge = ctypes.windll.comctl32.DPA_Merge
DPA_Merge.restype = wintypes.BOOL
DPA_Merge.argtypes = [
    ctypes.c_ssize_t,  # hdpaDest : HDPA
    ctypes.c_ssize_t,  # hdpaSrc : HDPA
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pfnCompare : PFNDACOMPARE
    ctypes.c_void_p,  # pfnMerge : PFNDPAMERGE
    ctypes.c_ssize_t,  # lParam : LPARAM
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
DPA_Merge = Fiddle::Function.new(
  lib['DPA_Merge'],
  [
    Fiddle::TYPE_INTPTR_T,  # hdpaDest : HDPA
    Fiddle::TYPE_INTPTR_T,  # hdpaSrc : HDPA
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pfnCompare : PFNDACOMPARE
    Fiddle::TYPE_VOIDP,  # pfnMerge : PFNDPAMERGE
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn DPA_Merge(
        hdpaDest: isize,  // HDPA
        hdpaSrc: isize,  // HDPA
        dwFlags: u32,  // DWORD
        pfnCompare: *const core::ffi::c_void,  // PFNDACOMPARE
        pfnMerge: *const core::ffi::c_void,  // PFNDPAMERGE
        lParam: isize  // LPARAM
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll")]
public static extern bool DPA_Merge(IntPtr hdpaDest, IntPtr hdpaSrc, uint dwFlags, IntPtr pfnCompare, IntPtr pfnMerge, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_DPA_Merge' -Namespace Win32 -PassThru
# $api::DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
#uselib "COMCTL32.dll"
#func global DPA_Merge "DPA_Merge" sptr, sptr, sptr, sptr, sptr, sptr
; DPA_Merge hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam   ; 戻り値は stat
; hdpaDest : HDPA -> "sptr"
; hdpaSrc : HDPA -> "sptr"
; dwFlags : DWORD -> "sptr"
; pfnCompare : PFNDACOMPARE -> "sptr"
; pfnMerge : PFNDPAMERGE -> "sptr"
; lParam : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "COMCTL32.dll"
#cfunc global DPA_Merge "DPA_Merge" sptr, sptr, int, sptr, sptr, sptr
; res = DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
; hdpaDest : HDPA -> "sptr"
; hdpaSrc : HDPA -> "sptr"
; dwFlags : DWORD -> "int"
; pfnCompare : PFNDACOMPARE -> "sptr"
; pfnMerge : PFNDPAMERGE -> "sptr"
; lParam : LPARAM -> "sptr"
; BOOL DPA_Merge(HDPA hdpaDest, HDPA hdpaSrc, DWORD dwFlags, PFNDACOMPARE pfnCompare, PFNDPAMERGE pfnMerge, LPARAM lParam)
#uselib "COMCTL32.dll"
#cfunc global DPA_Merge "DPA_Merge" intptr, intptr, int, intptr, intptr, intptr
; res = DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
; hdpaDest : HDPA -> "intptr"
; hdpaSrc : HDPA -> "intptr"
; dwFlags : DWORD -> "int"
; pfnCompare : PFNDACOMPARE -> "intptr"
; pfnMerge : PFNDPAMERGE -> "intptr"
; lParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procDPA_Merge = comctl32.NewProc("DPA_Merge")
)

// hdpaDest (HDPA), hdpaSrc (HDPA), dwFlags (DWORD), pfnCompare (PFNDACOMPARE), pfnMerge (PFNDPAMERGE), lParam (LPARAM)
r1, _, err := procDPA_Merge.Call(
	uintptr(hdpaDest),
	uintptr(hdpaSrc),
	uintptr(dwFlags),
	uintptr(pfnCompare),
	uintptr(pfnMerge),
	uintptr(lParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DPA_Merge(
  hdpaDest: NativeInt;   // HDPA
  hdpaSrc: NativeInt;   // HDPA
  dwFlags: DWORD;   // DWORD
  pfnCompare: Pointer;   // PFNDACOMPARE
  pfnMerge: Pointer;   // PFNDPAMERGE
  lParam: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'COMCTL32.dll' name 'DPA_Merge';
result := DllCall("COMCTL32\DPA_Merge"
    , "Ptr", hdpaDest   ; HDPA
    , "Ptr", hdpaSrc   ; HDPA
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pfnCompare   ; PFNDACOMPARE
    , "Ptr", pfnMerge   ; PFNDPAMERGE
    , "Ptr", lParam   ; LPARAM
    , "Int")   ; return: BOOL
●DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam) = DLL("COMCTL32.dll", "bool DPA_Merge(int, int, dword, void*, void*, int)")
# 呼び出し: DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
# hdpaDest : HDPA -> "int"
# hdpaSrc : HDPA -> "int"
# dwFlags : DWORD -> "dword"
# pfnCompare : PFNDACOMPARE -> "void*"
# pfnMerge : PFNDPAMERGE -> "void*"
# lParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "comctl32" fn DPA_Merge(
    hdpaDest: isize, // HDPA
    hdpaSrc: isize, // HDPA
    dwFlags: u32, // DWORD
    pfnCompare: ?*anyopaque, // PFNDACOMPARE
    pfnMerge: ?*anyopaque, // PFNDPAMERGE
    lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) i32;
proc DPA_Merge(
    hdpaDest: int,  # HDPA
    hdpaSrc: int,  # HDPA
    dwFlags: uint32,  # DWORD
    pfnCompare: pointer,  # PFNDACOMPARE
    pfnMerge: pointer,  # PFNDPAMERGE
    lParam: int  # LPARAM
): int32 {.importc: "DPA_Merge", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
int DPA_Merge(
    ptrdiff_t hdpaDest,   // HDPA
    ptrdiff_t hdpaSrc,   // HDPA
    uint dwFlags,   // DWORD
    void* pfnCompare,   // PFNDACOMPARE
    void* pfnMerge,   // PFNDPAMERGE
    ptrdiff_t lParam   // LPARAM
);
ccall((:DPA_Merge, "COMCTL32.dll"), stdcall, Int32,
      (Int, Int, UInt32, Ptr{Cvoid}, Ptr{Cvoid}, Int),
      hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
# hdpaDest : HDPA -> Int
# hdpaSrc : HDPA -> Int
# dwFlags : DWORD -> UInt32
# pfnCompare : PFNDACOMPARE -> Ptr{Cvoid}
# pfnMerge : PFNDPAMERGE -> Ptr{Cvoid}
# lParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DPA_Merge(
    intptr_t hdpaDest,
    intptr_t hdpaSrc,
    uint32_t dwFlags,
    void* pfnCompare,
    void* pfnMerge,
    intptr_t lParam);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
-- hdpaDest : HDPA
-- hdpaSrc : HDPA
-- dwFlags : DWORD
-- pfnCompare : PFNDACOMPARE
-- pfnMerge : PFNDPAMERGE
-- lParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const DPA_Merge = lib.func('__stdcall', 'DPA_Merge', 'int32_t', ['intptr_t', 'intptr_t', 'uint32_t', 'void *', 'void *', 'intptr_t']);
// DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
// hdpaDest : HDPA -> 'intptr_t'
// hdpaSrc : HDPA -> 'intptr_t'
// dwFlags : DWORD -> 'uint32_t'
// pfnCompare : PFNDACOMPARE -> 'void *'
// pfnMerge : PFNDPAMERGE -> 'void *'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("COMCTL32.dll", {
  DPA_Merge: { parameters: ["isize", "isize", "u32", "pointer", "pointer", "isize"], result: "i32" },
});
// lib.symbols.DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam)
// hdpaDest : HDPA -> "isize"
// hdpaSrc : HDPA -> "isize"
// dwFlags : DWORD -> "u32"
// pfnCompare : PFNDACOMPARE -> "pointer"
// pfnMerge : PFNDPAMERGE -> "pointer"
// lParam : LPARAM -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DPA_Merge(
    intptr_t hdpaDest,
    intptr_t hdpaSrc,
    uint32_t dwFlags,
    void* pfnCompare,
    void* pfnMerge,
    intptr_t lParam);
C, "COMCTL32.dll");
// $ffi->DPA_Merge(hdpaDest, hdpaSrc, dwFlags, pfnCompare, pfnMerge, lParam);
// hdpaDest : HDPA
// hdpaSrc : HDPA
// dwFlags : DWORD
// pfnCompare : PFNDACOMPARE
// pfnMerge : PFNDPAMERGE
// lParam : LPARAM
// 構造体/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 Comctl32 extends StdCallLibrary {
    Comctl32 INSTANCE = Native.load("comctl32", Comctl32.class);
    boolean DPA_Merge(
        long hdpaDest,   // HDPA
        long hdpaSrc,   // HDPA
        int dwFlags,   // DWORD
        Callback pfnCompare,   // PFNDACOMPARE
        Callback pfnMerge,   // PFNDPAMERGE
        long lParam   // LPARAM
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun DPA_Merge = DPA_Merge(
    hdpaDest : LibC::SSizeT,   # HDPA
    hdpaSrc : LibC::SSizeT,   # HDPA
    dwFlags : UInt32,   # DWORD
    pfnCompare : Void*,   # PFNDACOMPARE
    pfnMerge : Void*,   # PFNDPAMERGE
    lParam : LibC::SSizeT   # LPARAM
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DPA_MergeNative = Int32 Function(IntPtr, IntPtr, Uint32, Pointer<Void>, Pointer<Void>, IntPtr);
typedef DPA_MergeDart = int Function(int, int, int, Pointer<Void>, Pointer<Void>, int);
final DPA_Merge = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<DPA_MergeNative, DPA_MergeDart>('DPA_Merge');
// hdpaDest : HDPA -> IntPtr
// hdpaSrc : HDPA -> IntPtr
// dwFlags : DWORD -> Uint32
// pfnCompare : PFNDACOMPARE -> Pointer<Void>
// pfnMerge : PFNDPAMERGE -> Pointer<Void>
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DPA_Merge(
  hdpaDest: NativeInt;   // HDPA
  hdpaSrc: NativeInt;   // HDPA
  dwFlags: DWORD;   // DWORD
  pfnCompare: Pointer;   // PFNDACOMPARE
  pfnMerge: Pointer;   // PFNDPAMERGE
  lParam: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'COMCTL32.dll' name 'DPA_Merge';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DPA_Merge"
  c_DPA_Merge :: CIntPtr -> CIntPtr -> Word32 -> Ptr () -> Ptr () -> CIntPtr -> IO CInt
-- hdpaDest : HDPA -> CIntPtr
-- hdpaSrc : HDPA -> CIntPtr
-- dwFlags : DWORD -> Word32
-- pfnCompare : PFNDACOMPARE -> Ptr ()
-- pfnMerge : PFNDPAMERGE -> Ptr ()
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dpa_merge =
  foreign "DPA_Merge"
    (intptr_t @-> intptr_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> intptr_t @-> returning int32_t)
(* hdpaDest : HDPA -> intptr_t *)
(* hdpaSrc : HDPA -> intptr_t *)
(* dwFlags : DWORD -> uint32_t *)
(* pfnCompare : PFNDACOMPARE -> (ptr void) *)
(* pfnMerge : PFNDPAMERGE -> (ptr void) *)
(* lParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("DPA_Merge" dpa-merge :convention :stdcall) :int32
  (hdpa-dest :int64)   ; HDPA
  (hdpa-src :int64)   ; HDPA
  (dw-flags :uint32)   ; DWORD
  (pfn-compare :pointer)   ; PFNDACOMPARE
  (pfn-merge :pointer)   ; PFNDPAMERGE
  (l-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DPA_Merge = Win32::API::More->new('COMCTL32',
    'BOOL DPA_Merge(LPARAM hdpaDest, LPARAM hdpaSrc, DWORD dwFlags, LPVOID pfnCompare, LPVOID pfnMerge, LPARAM lParam)');
# my $ret = $DPA_Merge->Call($hdpaDest, $hdpaSrc, $dwFlags, $pfnCompare, $pfnMerge, $lParam);
# hdpaDest : HDPA -> LPARAM
# hdpaSrc : HDPA -> LPARAM
# dwFlags : DWORD -> DWORD
# pfnCompare : PFNDACOMPARE -> LPVOID
# pfnMerge : PFNDPAMERGE -> LPVOID
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型