ホーム › System.DataExchange › DdeConnectList

DdeConnectList

関数

指定サービスとトピックに合致するDDE会話の一覧を確立する。

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

シグネチャ

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

HCONVLIST DdeConnectList(
    DWORD idInst,
    HSZ hszService,
    HSZ hszTopic,
    HCONVLIST hConvList,
    CONVCONTEXT* pCC   // optional
);

パラメーター

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

戻り値の型: HCONVLIST

公式ドキュメント

指定されたサービス名とトピック名のペアをサポートするすべてのサーバーアプリケーションとの会話を確立します。

戻り値

型: HCONVLIST

関数が成功した場合、戻り値は新しい会話リストへのハンドルです。

関数が失敗した場合、戻り値は 0L です。古い会話リストへのハンドルは無効になります。

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

解説(Remarks)

アプリケーションは、リスト内の会話ハンドルがアクティブであるかどうかにかかわらず、DdeConnectList 関数が返した会話リストハンドルを解放する必要があります。ハンドルを解放するには、アプリケーションは DdeDisconnectList を呼び出すことができます。

既定の CONVCONTEXT 構造体のすべてのメンバーは、構造体のサイズを指定する 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>

HCONVLIST DdeConnectList(
    DWORD idInst,
    HSZ hszService,
    HSZ hszTopic,
    HCONVLIST hConvList,
    CONVCONTEXT* pCC   // optional
);

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

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

' idInst : DWORD
' hszService : HSZ
' hszTopic : HSZ
' hConvList : HCONVLIST
' pCC : CONVCONTEXT* optional
Declare PtrSafe Function DdeConnectList Lib "user32" ( _
    ByVal idInst As Long, _
    ByVal hszService As LongPtr, _
    ByVal hszTopic As LongPtr, _
    ByVal hConvList 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "user32")]
extern "system" {
    fn DdeConnectList(
        idInst: u32,  // DWORD
        hszService: *mut core::ffi::c_void,  // HSZ
        hszTopic: *mut core::ffi::c_void,  // HSZ
        hConvList: *mut core::ffi::c_void,  // HCONVLIST
        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 DdeConnectList(uint idInst, IntPtr hszService, IntPtr hszTopic, IntPtr hConvList, IntPtr pCC);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeConnectList' -Namespace Win32 -PassThru
# $api::DdeConnectList(idInst, hszService, hszTopic, hConvList, pCC)

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

出力引数:

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