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

ConnectToConnectionPoint

関数
接続ポイントへのイベントシンク接続を確立または解除する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT ConnectToConnectionPoint(
    IUnknown* punk,   // optional
    const GUID* riidEvent,
    BOOL fConnect,
    IUnknown* punkTarget,
    DWORD* pdwCookie,
    IConnectionPoint** ppcpOut   // optional
);

パラメーター

名前方向説明
punkIUnknown*inoptionalコネクションポイントコンテナーに接続するオブジェクトの IUnknown インターフェイスへのポインター。オブジェクトの接続を切断することを示すために fConnectFALSE に設定する場合、このパラメーターは無視され、NULL を設定できます。
riidEventGUID*in要求するコネクションポイントオブジェクトを持つ、コネクションポイントコンテナー上のインターフェイスの IID。
fConnectBOOLin接続を確立する場合は TRUE、接続を切断する場合は FALSE
punkTargetIUnknown*inコネクションポイントコンテナーの IUnknown インターフェイスへのポインター。
pdwCookieDWORD*out接続トークン。新しい接続を確立するために fConnectTRUE に設定した場合、このパラメーターは接続を一意に識別するトークンを受け取ります。接続を切断するために fConnectFALSE に設定した場合、このパラメーターは、接続を確立するために ConnectToConnectionPoint を呼び出したときに受け取ったトークンを指している必要があります。
ppcpOutIConnectionPoint**outoptional操作が成功した場合の、コネクションポイントコンテナーの IConnectionPoint インターフェイスへのポインター。呼び出し元のアプリケーションは、不要になったらこのポインターを解放する必要があります。要求が失敗した場合、ポインターは NULL を受け取ります。このパラメーターは省略可能で、NULL を指定できます。

戻り値の型: HRESULT

公式ドキュメント

クライアントのシンクとコネクションポイントコンテナーの間の接続を確立または終了します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

各言語での呼び出し定義

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

HRESULT ConnectToConnectionPoint(
    IUnknown* punk,   // optional
    const GUID* riidEvent,
    BOOL fConnect,
    IUnknown* punkTarget,
    DWORD* pdwCookie,
    IConnectionPoint** ppcpOut   // optional
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int ConnectToConnectionPoint(
    IntPtr punk,   // IUnknown* optional
    ref Guid riidEvent,   // GUID*
    bool fConnect,   // BOOL
    IntPtr punkTarget,   // IUnknown*
    out uint pdwCookie,   // DWORD* out
    IntPtr ppcpOut   // IConnectionPoint** optional, out
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function ConnectToConnectionPoint(
    punk As IntPtr,   ' IUnknown* optional
    ByRef riidEvent As Guid,   ' GUID*
    fConnect As Boolean,   ' BOOL
    punkTarget As IntPtr,   ' IUnknown*
    <Out> ByRef pdwCookie As UInteger,   ' DWORD* out
    ppcpOut As IntPtr   ' IConnectionPoint** optional, out
) As Integer
End Function
' punk : IUnknown* optional
' riidEvent : GUID*
' fConnect : BOOL
' punkTarget : IUnknown*
' pdwCookie : DWORD* out
' ppcpOut : IConnectionPoint** optional, out
Declare PtrSafe Function ConnectToConnectionPoint Lib "shlwapi" ( _
    ByVal punk As LongPtr, _
    ByVal riidEvent As LongPtr, _
    ByVal fConnect As Long, _
    ByVal punkTarget As LongPtr, _
    ByRef pdwCookie As Long, _
    ByVal ppcpOut As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ConnectToConnectionPoint = ctypes.windll.shlwapi.ConnectToConnectionPoint
ConnectToConnectionPoint.restype = ctypes.c_int
ConnectToConnectionPoint.argtypes = [
    ctypes.c_void_p,  # punk : IUnknown* optional
    ctypes.c_void_p,  # riidEvent : GUID*
    wintypes.BOOL,  # fConnect : BOOL
    ctypes.c_void_p,  # punkTarget : IUnknown*
    ctypes.POINTER(wintypes.DWORD),  # pdwCookie : DWORD* out
    ctypes.c_void_p,  # ppcpOut : IConnectionPoint** optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
ConnectToConnectionPoint = Fiddle::Function.new(
  lib['ConnectToConnectionPoint'],
  [
    Fiddle::TYPE_VOIDP,  # punk : IUnknown* optional
    Fiddle::TYPE_VOIDP,  # riidEvent : GUID*
    Fiddle::TYPE_INT,  # fConnect : BOOL
    Fiddle::TYPE_VOIDP,  # punkTarget : IUnknown*
    Fiddle::TYPE_VOIDP,  # pdwCookie : DWORD* out
    Fiddle::TYPE_VOIDP,  # ppcpOut : IConnectionPoint** optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn ConnectToConnectionPoint(
        punk: *mut core::ffi::c_void,  // IUnknown* optional
        riidEvent: *const GUID,  // GUID*
        fConnect: i32,  // BOOL
        punkTarget: *mut core::ffi::c_void,  // IUnknown*
        pdwCookie: *mut u32,  // DWORD* out
        ppcpOut: *mut *mut core::ffi::c_void  // IConnectionPoint** optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int ConnectToConnectionPoint(IntPtr punk, ref Guid riidEvent, bool fConnect, IntPtr punkTarget, out uint pdwCookie, IntPtr ppcpOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_ConnectToConnectionPoint' -Namespace Win32 -PassThru
# $api::ConnectToConnectionPoint(punk, riidEvent, fConnect, punkTarget, pdwCookie, ppcpOut)
#uselib "SHLWAPI.dll"
#func global ConnectToConnectionPoint "ConnectToConnectionPoint" sptr, sptr, sptr, sptr, sptr, sptr
; ConnectToConnectionPoint punk, varptr(riidEvent), fConnect, punkTarget, varptr(pdwCookie), ppcpOut   ; 戻り値は stat
; punk : IUnknown* optional -> "sptr"
; riidEvent : GUID* -> "sptr"
; fConnect : BOOL -> "sptr"
; punkTarget : IUnknown* -> "sptr"
; pdwCookie : DWORD* out -> "sptr"
; ppcpOut : IConnectionPoint** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global ConnectToConnectionPoint "ConnectToConnectionPoint" sptr, var, int, sptr, var, sptr
; res = ConnectToConnectionPoint(punk, riidEvent, fConnect, punkTarget, pdwCookie, ppcpOut)
; punk : IUnknown* optional -> "sptr"
; riidEvent : GUID* -> "var"
; fConnect : BOOL -> "int"
; punkTarget : IUnknown* -> "sptr"
; pdwCookie : DWORD* out -> "var"
; ppcpOut : IConnectionPoint** optional, out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT ConnectToConnectionPoint(IUnknown* punk, GUID* riidEvent, BOOL fConnect, IUnknown* punkTarget, DWORD* pdwCookie, IConnectionPoint** ppcpOut)
#uselib "SHLWAPI.dll"
#cfunc global ConnectToConnectionPoint "ConnectToConnectionPoint" intptr, var, int, intptr, var, intptr
; res = ConnectToConnectionPoint(punk, riidEvent, fConnect, punkTarget, pdwCookie, ppcpOut)
; punk : IUnknown* optional -> "intptr"
; riidEvent : GUID* -> "var"
; fConnect : BOOL -> "int"
; punkTarget : IUnknown* -> "intptr"
; pdwCookie : DWORD* out -> "var"
; ppcpOut : IConnectionPoint** optional, out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procConnectToConnectionPoint = shlwapi.NewProc("ConnectToConnectionPoint")
)

// punk (IUnknown* optional), riidEvent (GUID*), fConnect (BOOL), punkTarget (IUnknown*), pdwCookie (DWORD* out), ppcpOut (IConnectionPoint** optional, out)
r1, _, err := procConnectToConnectionPoint.Call(
	uintptr(punk),
	uintptr(riidEvent),
	uintptr(fConnect),
	uintptr(punkTarget),
	uintptr(pdwCookie),
	uintptr(ppcpOut),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function ConnectToConnectionPoint(
  punk: Pointer;   // IUnknown* optional
  riidEvent: PGUID;   // GUID*
  fConnect: BOOL;   // BOOL
  punkTarget: Pointer;   // IUnknown*
  pdwCookie: Pointer;   // DWORD* out
  ppcpOut: Pointer   // IConnectionPoint** optional, out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'ConnectToConnectionPoint';
result := DllCall("SHLWAPI\ConnectToConnectionPoint"
    , "Ptr", punk   ; IUnknown* optional
    , "Ptr", riidEvent   ; GUID*
    , "Int", fConnect   ; BOOL
    , "Ptr", punkTarget   ; IUnknown*
    , "Ptr", pdwCookie   ; DWORD* out
    , "Ptr", ppcpOut   ; IConnectionPoint** optional, out
    , "Int")   ; return: HRESULT
●ConnectToConnectionPoint(punk, riidEvent, fConnect, punkTarget, pdwCookie, ppcpOut) = DLL("SHLWAPI.dll", "int ConnectToConnectionPoint(void*, void*, bool, void*, void*, void*)")
# 呼び出し: ConnectToConnectionPoint(punk, riidEvent, fConnect, punkTarget, pdwCookie, ppcpOut)
# punk : IUnknown* optional -> "void*"
# riidEvent : GUID* -> "void*"
# fConnect : BOOL -> "bool"
# punkTarget : IUnknown* -> "void*"
# pdwCookie : DWORD* out -> "void*"
# ppcpOut : IConnectionPoint** optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ConnectToConnectionPointNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef ConnectToConnectionPointDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final ConnectToConnectionPoint = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<ConnectToConnectionPointNative, ConnectToConnectionPointDart>('ConnectToConnectionPoint');
// punk : IUnknown* optional -> Pointer<Void>
// riidEvent : GUID* -> Pointer<Void>
// fConnect : BOOL -> Int32
// punkTarget : IUnknown* -> Pointer<Void>
// pdwCookie : DWORD* out -> Pointer<Uint32>
// ppcpOut : IConnectionPoint** optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ConnectToConnectionPoint(
  punk: Pointer;   // IUnknown* optional
  riidEvent: PGUID;   // GUID*
  fConnect: BOOL;   // BOOL
  punkTarget: Pointer;   // IUnknown*
  pdwCookie: Pointer;   // DWORD* out
  ppcpOut: Pointer   // IConnectionPoint** optional, out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'ConnectToConnectionPoint';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ConnectToConnectionPoint"
  c_ConnectToConnectionPoint :: Ptr () -> Ptr () -> CInt -> Ptr () -> Ptr Word32 -> Ptr () -> IO Int32
-- punk : IUnknown* optional -> Ptr ()
-- riidEvent : GUID* -> Ptr ()
-- fConnect : BOOL -> CInt
-- punkTarget : IUnknown* -> Ptr ()
-- pdwCookie : DWORD* out -> Ptr Word32
-- ppcpOut : IConnectionPoint** optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let connecttoconnectionpoint =
  foreign "ConnectToConnectionPoint"
    ((ptr void) @-> (ptr void) @-> int32_t @-> (ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* punk : IUnknown* optional -> (ptr void) *)
(* riidEvent : GUID* -> (ptr void) *)
(* fConnect : BOOL -> int32_t *)
(* punkTarget : IUnknown* -> (ptr void) *)
(* pdwCookie : DWORD* out -> (ptr uint32_t) *)
(* ppcpOut : IConnectionPoint** optional, out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("ConnectToConnectionPoint" connect-to-connection-point :convention :stdcall) :int32
  (punk :pointer)   ; IUnknown* optional
  (riid-event :pointer)   ; GUID*
  (f-connect :int32)   ; BOOL
  (punk-target :pointer)   ; IUnknown*
  (pdw-cookie :pointer)   ; DWORD* out
  (ppcp-out :pointer))   ; IConnectionPoint** optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ConnectToConnectionPoint = Win32::API::More->new('SHLWAPI',
    'int ConnectToConnectionPoint(LPVOID punk, LPVOID riidEvent, BOOL fConnect, LPVOID punkTarget, LPVOID pdwCookie, LPVOID ppcpOut)');
# my $ret = $ConnectToConnectionPoint->Call($punk, $riidEvent, $fConnect, $punkTarget, $pdwCookie, $ppcpOut);
# punk : IUnknown* optional -> LPVOID
# riidEvent : GUID* -> LPVOID
# fConnect : BOOL -> BOOL
# punkTarget : IUnknown* -> LPVOID
# pdwCookie : DWORD* out -> LPVOID
# ppcpOut : IConnectionPoint** optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型