DdeConnect

関数

指定サービスとトピックでDDEサーバーとの会話を確立する。

DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HCONV DdeConnect(
    DWORD idInst,
    HSZ hszService,
    HSZ hszTopic,
    CONVCONTEXT* pCC   // optional
);

パラメーター

名前	型	方向	説明
idInst	DWORD	in	DdeInitialize 関数の以前の呼び出しによって取得されたアプリケーションインスタンス識別子。
hszService	HSZ	in	会話を確立するサーバーアプリケーションのサービス名を指定する文字列へのハンドル。このハンドルは、DdeCreateStringHandle 関数の以前の呼び出しによって作成されている必要があります。このパラメーターが 0L の場合、利用可能な任意のサーバーとの会話が確立されます。
hszTopic	HSZ	in	会話を確立するトピックの名前を指定する文字列へのハンドル。このハンドルは、DdeCreateStringHandle の以前の呼び出しによって作成されている必要があります。このパラメーターが 0L の場合、選択されたサーバーがサポートする任意のトピックでの会話が確立されます。
pCC	CONVCONTEXT*	inoptional	会話コンテキスト情報を格納する CONVCONTEXT 構造体へのポインター。このパラメーターが NULL の場合、サーバーは XTYP_CONNECT または XTYP_WILDCONNECT トランザクション中にデフォルトの CONVCONTEXT 構造体を受け取ります。

戻り値の型: HCONV

公式ドキュメント

指定されたサービス名とトピック名のペアをサポートするサーバーアプリケーションとの会話を確立します。そのようなサーバーが複数存在する場合、システムはそのうちの 1 つだけを選択します。

戻り値

型: HCONV

関数が成功すると、戻り値は確立された会話へのハンドルです。

関数が失敗すると、戻り値は 0L です。

DdeGetLastError 関数を使用してエラーコードを取得できます。エラーコードは次のいずれかの値になります。

解説(Remarks)

クライアントアプリケーションは、選択されるサーバーについて何らかの想定をすることはできません。 hszService パラメーターにインスタンス固有の名前が指定されている場合、指定されたインスタンスとのみ会話が確立されます。インスタンス固有のサービス名は、XTYP_REGISTER および XTYP_UNREGISTER トランザクション中にアプリケーションの動的データ交換 (DDE) コールバック関数に渡されます。

デフォルトの CONVCONTEXT 構造体のすべてのメンバーは 0 に設定されますが、構造体のサイズを指定する cb と、クライアントアプリケーションが DdeInitialize 関数の ANSI 版と Unicode 版のどちらを呼び出したかに応じて CP_WINANSI (デフォルトのコードページ) または CP_WINUNICODE を指定する iCodePage は例外です。

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

各言語での呼び出し定義

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

HCONV DdeConnect(
    DWORD idInst,
    HSZ hszService,
    HSZ hszTopic,
    CONVCONTEXT* pCC   // optional
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr DdeConnect(
    uint idInst,   // DWORD
    IntPtr hszService,   // HSZ
    IntPtr hszTopic,   // HSZ
    IntPtr pCC   // CONVCONTEXT* optional
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DdeConnect(
    idInst As UInteger,   ' DWORD
    hszService As IntPtr,   ' HSZ
    hszTopic As IntPtr,   ' HSZ
    pCC As IntPtr   ' CONVCONTEXT* optional
) As IntPtr
End Function

' idInst : DWORD
' hszService : HSZ
' hszTopic : HSZ
' pCC : CONVCONTEXT* optional
Declare PtrSafe Function DdeConnect Lib "user32" ( _
    ByVal idInst As Long, _
    ByVal hszService As LongPtr, _
    ByVal hszTopic As LongPtr, _
    ByVal pCC As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DdeConnect = ctypes.windll.user32.DdeConnect
DdeConnect.restype = ctypes.c_void_p
DdeConnect.argtypes = [
    wintypes.DWORD,  # idInst : DWORD
    wintypes.HANDLE,  # hszService : HSZ
    wintypes.HANDLE,  # hszTopic : HSZ
    ctypes.c_void_p,  # pCC : CONVCONTEXT* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeConnect = Fiddle::Function.new(
  lib['DdeConnect'],
  [
    -Fiddle::TYPE_INT,  # idInst : DWORD
    Fiddle::TYPE_VOIDP,  # hszService : HSZ
    Fiddle::TYPE_VOIDP,  # hszTopic : HSZ
    Fiddle::TYPE_VOIDP,  # pCC : CONVCONTEXT* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "user32")]
extern "system" {
    fn DdeConnect(
        idInst: u32,  // DWORD
        hszService: *mut core::ffi::c_void,  // HSZ
        hszTopic: *mut core::ffi::c_void,  // HSZ
        pCC: *mut CONVCONTEXT  // CONVCONTEXT* optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern IntPtr DdeConnect(uint idInst, IntPtr hszService, IntPtr hszTopic, IntPtr pCC);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeConnect' -Namespace Win32 -PassThru
# $api::DdeConnect(idInst, hszService, hszTopic, pCC)

#uselib "USER32.dll"
#func global DdeConnect "DdeConnect" sptr, sptr, sptr, sptr
; DdeConnect idInst, hszService, hszTopic, varptr(pCC)   ; 戻り値は stat
; idInst : DWORD -> "sptr"
; hszService : HSZ -> "sptr"
; hszTopic : HSZ -> "sptr"
; pCC : CONVCONTEXT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DdeConnect "DdeConnect" int, sptr, sptr, var
; res = DdeConnect(idInst, hszService, hszTopic, pCC)
; idInst : DWORD -> "int"
; hszService : HSZ -> "sptr"
; hszTopic : HSZ -> "sptr"
; pCC : CONVCONTEXT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DdeConnect "DdeConnect" int, sptr, sptr, sptr
; res = DdeConnect(idInst, hszService, hszTopic, varptr(pCC))
; idInst : DWORD -> "int"
; hszService : HSZ -> "sptr"
; hszTopic : HSZ -> "sptr"
; pCC : CONVCONTEXT* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。