ホーム › System.DataExchange › DdeQueryConvInfo

DdeQueryConvInfo

関数

指定したDDE会話とトランザクションの情報を取得する。

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

シグネチャ

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

DWORD DdeQueryConvInfo(
    HCONV hConv,
    DWORD idTransaction,
    CONVINFO* pConvInfo
);

パラメーター

名前	型	方向	説明
hConv	HCONV	in	会話へのハンドルです。
idTransaction	DWORD	in	トランザクションです。非同期トランザクションの場合、このパラメーターには DdeClientTransaction 関数が返したトランザクション識別子を指定します。同期トランザクションの場合、このパラメーターには QID_SYNC を指定します。
pConvInfo	CONVINFO*	inout	トランザクションおよび会話に関する情報を受け取る CONVINFO 構造体へのポインターです。 CONVINFO 構造体の cb メンバーには、この構造体用に確保したバッファーの長さを指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

動的データ交換(DDE)トランザクション、およびそのトランザクションが行われる会話に関する情報を取得します。

戻り値

型: UINT

関数が成功した場合、戻り値は CONVINFO 構造体にコピーされたバイト数です。

関数が失敗した場合、戻り値は FALSE です。

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

解説(Remarks)

アプリケーションは、CONVINFO 構造体が参照する文字列ハンドルを解放してはなりません。これらの文字列ハンドルのいずれかを使用する必要がある場合は、DdeKeepStringHandle 関数を呼び出してハンドルのコピーを作成してください。

idTransaction パラメーターに QID_SYNC を設定した場合、CONVINFO 構造体の hUser メンバーは会話に関連付けられ、その会話に関連するデータを保持するために使用できます。idTransaction が非同期トランザクションの識別子である場合、hUser メンバーは現在のトランザクションにのみ関連付けられ、そのトランザクションの実行中のみ有効です。

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

各言語での呼び出し定義

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

DWORD DdeQueryConvInfo(
    HCONV hConv,
    DWORD idTransaction,
    CONVINFO* pConvInfo
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern uint DdeQueryConvInfo(
    IntPtr hConv,   // HCONV
    uint idTransaction,   // DWORD
    IntPtr pConvInfo   // CONVINFO* in/out
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DdeQueryConvInfo(
    hConv As IntPtr,   ' HCONV
    idTransaction As UInteger,   ' DWORD
    pConvInfo As IntPtr   ' CONVINFO* in/out
) As UInteger
End Function

' hConv : HCONV
' idTransaction : DWORD
' pConvInfo : CONVINFO* in/out
Declare PtrSafe Function DdeQueryConvInfo Lib "user32" ( _
    ByVal hConv As LongPtr, _
    ByVal idTransaction As Long, _
    ByVal pConvInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DdeQueryConvInfo = ctypes.windll.user32.DdeQueryConvInfo
DdeQueryConvInfo.restype = wintypes.DWORD
DdeQueryConvInfo.argtypes = [
    wintypes.HANDLE,  # hConv : HCONV
    wintypes.DWORD,  # idTransaction : DWORD
    ctypes.c_void_p,  # pConvInfo : CONVINFO* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeQueryConvInfo = Fiddle::Function.new(
  lib['DdeQueryConvInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hConv : HCONV
    -Fiddle::TYPE_INT,  # idTransaction : DWORD
    Fiddle::TYPE_VOIDP,  # pConvInfo : CONVINFO* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn DdeQueryConvInfo(
        hConv: *mut core::ffi::c_void,  // HCONV
        idTransaction: u32,  // DWORD
        pConvInfo: *mut CONVINFO  // CONVINFO* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern uint DdeQueryConvInfo(IntPtr hConv, uint idTransaction, IntPtr pConvInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeQueryConvInfo' -Namespace Win32 -PassThru
# $api::DdeQueryConvInfo(hConv, idTransaction, pConvInfo)

#uselib "USER32.dll"
#func global DdeQueryConvInfo "DdeQueryConvInfo" sptr, sptr, sptr
; DdeQueryConvInfo hConv, idTransaction, varptr(pConvInfo)   ; 戻り値は stat
; hConv : HCONV -> "sptr"
; idTransaction : DWORD -> "sptr"
; pConvInfo : CONVINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DdeQueryConvInfo "DdeQueryConvInfo" sptr, int, var
; res = DdeQueryConvInfo(hConv, idTransaction, pConvInfo)
; hConv : HCONV -> "sptr"
; idTransaction : DWORD -> "int"
; pConvInfo : CONVINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DdeQueryConvInfo "DdeQueryConvInfo" sptr, int, sptr
; res = DdeQueryConvInfo(hConv, idTransaction, varptr(pConvInfo))
; hConv : HCONV -> "sptr"
; idTransaction : DWORD -> "int"
; pConvInfo : CONVINFO* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。