Win32 API 日本語リファレンス
ホームSystem.DataExchange › DdeGetData

DdeGetData

関数
DDEデータオブジェクトの内容をバッファにコピーする。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD DdeGetData(
    HDDEDATA hData,
    BYTE* pDst,   // optional
    DWORD cbMax,
    DWORD cbOff
);

パラメーター

名前方向説明
hDataHDDEDATAinコピーするデータを含む DDE オブジェクトへのハンドルです。
pDstBYTE*outoptionalデータを受け取るバッファーへのポインターです。このパラメーターが NULL の場合、DdeGetData 関数はバッファーにコピーされるデータの量をバイト単位で返します。
cbMaxDWORDin
                <i>pDst</i> パラメーターが指すバッファーへコピーするデータの最大量 (バイト単位) です。通常、このパラメーターには 
                <i>pDst</i> が指すバッファーの長さを指定します。
cbOffDWORDinDDE オブジェクト内のオフセットです。データはこのオフセットを起点としてオブジェクトからコピーされます。

戻り値の型: DWORD

公式ドキュメント

指定された動的データ交換 (DDE) オブジェクトから指定されたローカルバッファーへデータをコピーします。

戻り値

型: DWORD

                    <i>pDst</i> パラメーターがバッファーを指している場合、戻り値はデータハンドルに関連付けられたメモリオブジェクトのサイズ (バイト単位) と 
                    <i>cbMax</i> パラメーターで指定されたサイズのうち、小さい方の値です。

                    <i>pDst</i> パラメーターが <b>NULL</b> の場合、戻り値はデータハンドルに関連付けられたメモリオブジェクトのサイズ (バイト単位) です。

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

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

各言語での呼び出し定義

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

DWORD DdeGetData(
    HDDEDATA hData,
    BYTE* pDst,   // optional
    DWORD cbMax,
    DWORD cbOff
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern uint DdeGetData(
    IntPtr hData,   // HDDEDATA
    IntPtr pDst,   // BYTE* optional, out
    uint cbMax,   // DWORD
    uint cbOff   // DWORD
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DdeGetData(
    hData As IntPtr,   ' HDDEDATA
    pDst As IntPtr,   ' BYTE* optional, out
    cbMax As UInteger,   ' DWORD
    cbOff As UInteger   ' DWORD
) As UInteger
End Function
' hData : HDDEDATA
' pDst : BYTE* optional, out
' cbMax : DWORD
' cbOff : DWORD
Declare PtrSafe Function DdeGetData Lib "user32" ( _
    ByVal hData As LongPtr, _
    ByVal pDst As LongPtr, _
    ByVal cbMax As Long, _
    ByVal cbOff As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DdeGetData = ctypes.windll.user32.DdeGetData
DdeGetData.restype = wintypes.DWORD
DdeGetData.argtypes = [
    wintypes.HANDLE,  # hData : HDDEDATA
    ctypes.POINTER(ctypes.c_ubyte),  # pDst : BYTE* optional, out
    wintypes.DWORD,  # cbMax : DWORD
    wintypes.DWORD,  # cbOff : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeGetData = Fiddle::Function.new(
  lib['DdeGetData'],
  [
    Fiddle::TYPE_VOIDP,  # hData : HDDEDATA
    Fiddle::TYPE_VOIDP,  # pDst : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbMax : DWORD
    -Fiddle::TYPE_INT,  # cbOff : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn DdeGetData(
        hData: *mut core::ffi::c_void,  // HDDEDATA
        pDst: *mut u8,  // BYTE* optional, out
        cbMax: u32,  // DWORD
        cbOff: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern uint DdeGetData(IntPtr hData, IntPtr pDst, uint cbMax, uint cbOff);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeGetData' -Namespace Win32 -PassThru
# $api::DdeGetData(hData, pDst, cbMax, cbOff)
#uselib "USER32.dll"
#func global DdeGetData "DdeGetData" sptr, sptr, sptr, sptr
; DdeGetData hData, varptr(pDst), cbMax, cbOff   ; 戻り値は stat
; hData : HDDEDATA -> "sptr"
; pDst : BYTE* optional, out -> "sptr"
; cbMax : DWORD -> "sptr"
; cbOff : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global DdeGetData "DdeGetData" sptr, var, int, int
; res = DdeGetData(hData, pDst, cbMax, cbOff)
; hData : HDDEDATA -> "sptr"
; pDst : BYTE* optional, out -> "var"
; cbMax : DWORD -> "int"
; cbOff : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DdeGetData(HDDEDATA hData, BYTE* pDst, DWORD cbMax, DWORD cbOff)
#uselib "USER32.dll"
#cfunc global DdeGetData "DdeGetData" intptr, var, int, int
; res = DdeGetData(hData, pDst, cbMax, cbOff)
; hData : HDDEDATA -> "intptr"
; pDst : BYTE* optional, out -> "var"
; cbMax : DWORD -> "int"
; cbOff : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDdeGetData = user32.NewProc("DdeGetData")
)

// hData (HDDEDATA), pDst (BYTE* optional, out), cbMax (DWORD), cbOff (DWORD)
r1, _, err := procDdeGetData.Call(
	uintptr(hData),
	uintptr(pDst),
	uintptr(cbMax),
	uintptr(cbOff),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DdeGetData(
  hData: THandle;   // HDDEDATA
  pDst: Pointer;   // BYTE* optional, out
  cbMax: DWORD;   // DWORD
  cbOff: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'DdeGetData';
result := DllCall("USER32\DdeGetData"
    , "Ptr", hData   ; HDDEDATA
    , "Ptr", pDst   ; BYTE* optional, out
    , "UInt", cbMax   ; DWORD
    , "UInt", cbOff   ; DWORD
    , "UInt")   ; return: DWORD
●DdeGetData(hData, pDst, cbMax, cbOff) = DLL("USER32.dll", "dword DdeGetData(void*, void*, dword, dword)")
# 呼び出し: DdeGetData(hData, pDst, cbMax, cbOff)
# hData : HDDEDATA -> "void*"
# pDst : BYTE* optional, out -> "void*"
# cbMax : DWORD -> "dword"
# cbOff : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn DdeGetData(
    hData: ?*anyopaque, // HDDEDATA
    pDst: [*c]u8, // BYTE* optional, out
    cbMax: u32, // DWORD
    cbOff: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc DdeGetData(
    hData: pointer,  # HDDEDATA
    pDst: ptr uint8,  # BYTE* optional, out
    cbMax: uint32,  # DWORD
    cbOff: uint32  # DWORD
): uint32 {.importc: "DdeGetData", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
uint DdeGetData(
    void* hData,   // HDDEDATA
    ubyte* pDst,   // BYTE* optional, out
    uint cbMax,   // DWORD
    uint cbOff   // DWORD
);
ccall((:DdeGetData, "USER32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt8}, UInt32, UInt32),
      hData, pDst, cbMax, cbOff)
# hData : HDDEDATA -> Ptr{Cvoid}
# pDst : BYTE* optional, out -> Ptr{UInt8}
# cbMax : DWORD -> UInt32
# cbOff : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DdeGetData(
    void* hData,
    uint8_t* pDst,
    uint32_t cbMax,
    uint32_t cbOff);
]]
local user32 = ffi.load("user32")
-- user32.DdeGetData(hData, pDst, cbMax, cbOff)
-- hData : HDDEDATA
-- pDst : BYTE* optional, out
-- cbMax : DWORD
-- cbOff : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const DdeGetData = lib.func('__stdcall', 'DdeGetData', 'uint32_t', ['void *', 'uint8_t *', 'uint32_t', 'uint32_t']);
// DdeGetData(hData, pDst, cbMax, cbOff)
// hData : HDDEDATA -> 'void *'
// pDst : BYTE* optional, out -> 'uint8_t *'
// cbMax : DWORD -> 'uint32_t'
// cbOff : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  DdeGetData: { parameters: ["pointer", "pointer", "u32", "u32"], result: "u32" },
});
// lib.symbols.DdeGetData(hData, pDst, cbMax, cbOff)
// hData : HDDEDATA -> "pointer"
// pDst : BYTE* optional, out -> "pointer"
// cbMax : DWORD -> "u32"
// cbOff : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DdeGetData(
    void* hData,
    uint8_t* pDst,
    uint32_t cbMax,
    uint32_t cbOff);
C, "USER32.dll");
// $ffi->DdeGetData(hData, pDst, cbMax, cbOff);
// hData : HDDEDATA
// pDst : BYTE* optional, out
// cbMax : DWORD
// cbOff : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    int DdeGetData(
        Pointer hData,   // HDDEDATA
        byte[] pDst,   // BYTE* optional, out
        int cbMax,   // DWORD
        int cbOff   // DWORD
    );
}
@[Link("user32")]
lib LibUSER32
  fun DdeGetData = DdeGetData(
    hData : Void*,   # HDDEDATA
    pDst : UInt8*,   # BYTE* optional, out
    cbMax : UInt32,   # DWORD
    cbOff : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DdeGetDataNative = Uint32 Function(Pointer<Void>, Pointer<Uint8>, Uint32, Uint32);
typedef DdeGetDataDart = int Function(Pointer<Void>, Pointer<Uint8>, int, int);
final DdeGetData = DynamicLibrary.open('USER32.dll')
    .lookupFunction<DdeGetDataNative, DdeGetDataDart>('DdeGetData');
// hData : HDDEDATA -> Pointer<Void>
// pDst : BYTE* optional, out -> Pointer<Uint8>
// cbMax : DWORD -> Uint32
// cbOff : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DdeGetData(
  hData: THandle;   // HDDEDATA
  pDst: Pointer;   // BYTE* optional, out
  cbMax: DWORD;   // DWORD
  cbOff: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'DdeGetData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DdeGetData"
  c_DdeGetData :: Ptr () -> Ptr Word8 -> Word32 -> Word32 -> IO Word32
-- hData : HDDEDATA -> Ptr ()
-- pDst : BYTE* optional, out -> Ptr Word8
-- cbMax : DWORD -> Word32
-- cbOff : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ddegetdata =
  foreign "DdeGetData"
    ((ptr void) @-> (ptr uint8_t) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hData : HDDEDATA -> (ptr void) *)
(* pDst : BYTE* optional, out -> (ptr uint8_t) *)
(* cbMax : DWORD -> uint32_t *)
(* cbOff : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("DdeGetData" dde-get-data :convention :stdcall) :uint32
  (h-data :pointer)   ; HDDEDATA
  (p-dst :pointer)   ; BYTE* optional, out
  (cb-max :uint32)   ; DWORD
  (cb-off :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DdeGetData = Win32::API::More->new('USER32',
    'DWORD DdeGetData(HANDLE hData, LPVOID pDst, DWORD cbMax, DWORD cbOff)');
# my $ret = $DdeGetData->Call($hData, $pDst, $cbMax, $cbOff);
# hData : HDDEDATA -> HANDLE
# pDst : BYTE* optional, out -> LPVOID
# cbMax : DWORD -> DWORD
# cbOff : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目