ホーム › System.DataExchange › DdeCreateDataHandle

DdeCreateDataHandle

関数

指定データから新しいDDEデータハンドルを作成する。

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

シグネチャ

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

HDDEDATA DdeCreateDataHandle(
    DWORD idInst,
    BYTE* pSrc,   // optional
    DWORD cb,
    DWORD cbOff,
    HSZ hszItem,   // optional
    DWORD wFmt,
    DWORD afCmd
);

パラメーター

名前	型	方向	説明
idInst	DWORD	in	以前に DdeInitialize 関数を呼び出して取得したアプリケーションインスタンス識別子。
pSrc	BYTE*	inoptional	DDE オブジェクトにコピーするデータ。このパラメーターが NULL の場合、オブジェクトにはデータがコピーされません。
cb	DWORD	in	`<i>pSrc</i> が指すバッファからコピーするメモリ量 (バイト単位)。(データが文字列の場合は終端の NULL を含めます)。このパラメーターが 0 の場合、 <i>pSrc</i> パラメーターは無視されます。`
cbOff	DWORD	in	`<i>pSrc</i> パラメーターが指すバッファの先頭からのオフセット (バイト単位)。このオフセット位置から始まるデータが、バッファから DDE オブジェクトへコピーされます。`
hszItem	HSZ	inoptional	DDE オブジェクトに対応するデータ項目を指定する文字列へのハンドル。このハンドルは、以前に DdeCreateStringHandle 関数を呼び出して作成しておく必要があります。データハンドルを XTYP_EXECUTE トランザクションで使用する場合、このパラメーターは 0L でなければなりません。
wFmt	DWORD	in	データの標準クリップボード形式。
afCmd	DWORD	in	作成フラグ。このパラメーターには HDATA_APPOWNED を指定できます。これは、DdeCreateDataHandle 関数を呼び出したサーバーアプリケーションが、この関数が作成するデータハンドルを所有することを指定します。このフラグを使用すると、アプリケーションは各アプリケーションへ渡す個別のハンドルを作成する代わりに、データハンドルを他の DDEML アプリケーションと共有できます。このフラグを指定した場合、アプリケーションは最終的に DdeFreeDataHandle 関数を使用して、ハンドルに関連付けられた共有メモリオブジェクトを解放する必要があります。このフラグを指定しない場合、ハンドルは、アプリケーションの DDE コールバック関数から返されるか、別の DDEML 関数のパラメーターとして使用された後、そのハンドルを作成したアプリケーション内で無効になります。

戻り値の型: HDDEDATA

公式ドキュメント

ダイナミックデータエクスチェンジ (DDE) オブジェクトを作成し、指定したバッファのデータでそのオブジェクトを満たします。DDE アプリケーションは、相手側アプリケーションへのデータ受け渡しを伴うトランザクションでこの関数を使用します。

戻り値

型: HDDEDATA

関数が成功した場合、戻り値はデータハンドルです。

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

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

解説(Remarks)

DDE オブジェクト内の未充填の位置は未定義です。

データハンドルが別の DDEML 関数のパラメーターとして使用された後、または DDE コールバック関数から返された後は、そのハンドルが識別する DDE オブジェクトへの読み取りアクセスにのみ使用できます。

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

各言語での呼び出し定義

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

HDDEDATA DdeCreateDataHandle(
    DWORD idInst,
    BYTE* pSrc,   // optional
    DWORD cb,
    DWORD cbOff,
    HSZ hszItem,   // optional
    DWORD wFmt,
    DWORD afCmd
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr DdeCreateDataHandle(
    uint idInst,   // DWORD
    IntPtr pSrc,   // BYTE* optional
    uint cb,   // DWORD
    uint cbOff,   // DWORD
    IntPtr hszItem,   // HSZ optional
    uint wFmt,   // DWORD
    uint afCmd   // DWORD
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DdeCreateDataHandle(
    idInst As UInteger,   ' DWORD
    pSrc As IntPtr,   ' BYTE* optional
    cb As UInteger,   ' DWORD
    cbOff As UInteger,   ' DWORD
    hszItem As IntPtr,   ' HSZ optional
    wFmt As UInteger,   ' DWORD
    afCmd As UInteger   ' DWORD
) As IntPtr
End Function

' idInst : DWORD
' pSrc : BYTE* optional
' cb : DWORD
' cbOff : DWORD
' hszItem : HSZ optional
' wFmt : DWORD
' afCmd : DWORD
Declare PtrSafe Function DdeCreateDataHandle Lib "user32" ( _
    ByVal idInst As Long, _
    ByVal pSrc As LongPtr, _
    ByVal cb As Long, _
    ByVal cbOff As Long, _
    ByVal hszItem As LongPtr, _
    ByVal wFmt As Long, _
    ByVal afCmd As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DdeCreateDataHandle = ctypes.windll.user32.DdeCreateDataHandle
DdeCreateDataHandle.restype = ctypes.c_void_p
DdeCreateDataHandle.argtypes = [
    wintypes.DWORD,  # idInst : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pSrc : BYTE* optional
    wintypes.DWORD,  # cb : DWORD
    wintypes.DWORD,  # cbOff : DWORD
    wintypes.HANDLE,  # hszItem : HSZ optional
    wintypes.DWORD,  # wFmt : DWORD
    wintypes.DWORD,  # afCmd : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeCreateDataHandle = Fiddle::Function.new(
  lib['DdeCreateDataHandle'],
  [
    -Fiddle::TYPE_INT,  # idInst : DWORD
    Fiddle::TYPE_VOIDP,  # pSrc : BYTE* optional
    -Fiddle::TYPE_INT,  # cb : DWORD
    -Fiddle::TYPE_INT,  # cbOff : DWORD
    Fiddle::TYPE_VOIDP,  # hszItem : HSZ optional
    -Fiddle::TYPE_INT,  # wFmt : DWORD
    -Fiddle::TYPE_INT,  # afCmd : DWORD
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "user32")]
extern "system" {
    fn DdeCreateDataHandle(
        idInst: u32,  // DWORD
        pSrc: *mut u8,  // BYTE* optional
        cb: u32,  // DWORD
        cbOff: u32,  // DWORD
        hszItem: *mut core::ffi::c_void,  // HSZ optional
        wFmt: u32,  // DWORD
        afCmd: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern IntPtr DdeCreateDataHandle(uint idInst, IntPtr pSrc, uint cb, uint cbOff, IntPtr hszItem, uint wFmt, uint afCmd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeCreateDataHandle' -Namespace Win32 -PassThru
# $api::DdeCreateDataHandle(idInst, pSrc, cb, cbOff, hszItem, wFmt, afCmd)

#uselib "USER32.dll"
#func global DdeCreateDataHandle "DdeCreateDataHandle" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DdeCreateDataHandle idInst, varptr(pSrc), cb, cbOff, hszItem, wFmt, afCmd   ; 戻り値は stat
; idInst : DWORD -> "sptr"
; pSrc : BYTE* optional -> "sptr"
; cb : DWORD -> "sptr"
; cbOff : DWORD -> "sptr"
; hszItem : HSZ optional -> "sptr"
; wFmt : DWORD -> "sptr"
; afCmd : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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