DdeAddData

関数

既存のDDEデータオブジェクトにデータを追加する。

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

シグネチャ

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

HDDEDATA DdeAddData(
    HDDEDATA hData,
    BYTE* pSrc,
    DWORD cb,
    DWORD cbOff
);

パラメーター

名前	型	方向	説明
hData	HDDEDATA	in	追加データを受け取る DDE オブジェクトへのハンドルです。
pSrc	BYTE*	in	DDE オブジェクトに追加するデータです。
cb	DWORD	in	DDE オブジェクトに追加するデータの長さ (バイト単位)。データが文字列の場合は、終端の NULL を含みます。
cbOff	DWORD	in	DDE オブジェクトの先頭からのオフセット (バイト単位)。追加データは、このオフセットの位置を起点としてオブジェクトにコピーされます。

戻り値の型: HDDEDATA

公式ドキュメント

指定したダイナミックデータ交換 (DDE) オブジェクトにデータを追加します。

戻り値

型: HDDEDATA

関数が成功した場合、戻り値は DDE オブジェクトへの新しいハンドルです。この新しいハンドルは、以降そのオブジェクトを参照するすべての場面で使用します。

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

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

解説(Remarks)

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

最初に割り当てられたメモリ量が、追加データを保持するのに必要な量より少ない場合、DdeAddData は適切なサイズのグローバルメモリオブジェクトを再割り当てします。

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

各言語での呼び出し定義

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

HDDEDATA DdeAddData(
    HDDEDATA hData,
    BYTE* pSrc,
    DWORD cb,
    DWORD cbOff
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr DdeAddData(
    IntPtr hData,   // HDDEDATA
    IntPtr pSrc,   // BYTE*
    uint cb,   // DWORD
    uint cbOff   // DWORD
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DdeAddData(
    hData As IntPtr,   ' HDDEDATA
    pSrc As IntPtr,   ' BYTE*
    cb As UInteger,   ' DWORD
    cbOff As UInteger   ' DWORD
) As IntPtr
End Function

' hData : HDDEDATA
' pSrc : BYTE*
' cb : DWORD
' cbOff : DWORD
Declare PtrSafe Function DdeAddData Lib "user32" ( _
    ByVal hData As LongPtr, _
    ByVal pSrc As LongPtr, _
    ByVal cb As Long, _
    ByVal cbOff As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DdeAddData = ctypes.windll.user32.DdeAddData
DdeAddData.restype = ctypes.c_void_p
DdeAddData.argtypes = [
    wintypes.HANDLE,  # hData : HDDEDATA
    ctypes.POINTER(ctypes.c_ubyte),  # pSrc : BYTE*
    wintypes.DWORD,  # cb : DWORD
    wintypes.DWORD,  # cbOff : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeAddData = Fiddle::Function.new(
  lib['DdeAddData'],
  [
    Fiddle::TYPE_VOIDP,  # hData : HDDEDATA
    Fiddle::TYPE_VOIDP,  # pSrc : BYTE*
    -Fiddle::TYPE_INT,  # cb : DWORD
    -Fiddle::TYPE_INT,  # cbOff : DWORD
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "user32")]
extern "system" {
    fn DdeAddData(
        hData: *mut core::ffi::c_void,  // HDDEDATA
        pSrc: *mut u8,  // BYTE*
        cb: u32,  // DWORD
        cbOff: 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 DdeAddData(IntPtr hData, IntPtr pSrc, uint cb, uint cbOff);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeAddData' -Namespace Win32 -PassThru
# $api::DdeAddData(hData, pSrc, cb, cbOff)

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

出力引数:

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