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

DdeEnableCallback

関数
DDEトランザクションのコールバックを有効化または無効化する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL DdeEnableCallback(
    DWORD idInst,
    HCONV hConv,
    DDE_ENABLE_CALLBACK_CMD wCmd
);

パラメーター

名前方向説明
idInstDWORDin以前の DdeInitialize 関数の呼び出しによって取得したアプリケーションインスタンス識別子です。
hConvHCONVin有効または無効にする会話へのハンドルです。このパラメーターが NULL の場合、関数はすべての会話に影響します。
wCmdDDE_ENABLE_CALLBACK_CMDin

機能コードです。このパラメーターには次のいずれかの値を指定できます。

意味
EC_ENABLEALL
0
指定した会話のすべてのトランザクションを有効にします。
EC_ENABLEONE
0x0080
指定した会話の1件のトランザクションを有効にします。
EC_DISABLE
0x0008
指定した会話のブロック可能なすべてのトランザクションを無効にします。

サーバーアプリケーションは次のトランザクションを無効にできます。

クライアントアプリケーションは次のトランザクションを無効にできます。
EC_QUERYWAITING
2
指定した会話のキューにトランザクションが存在するかどうかを判定します。

戻り値の型: BOOL

公式ドキュメント

特定の会話、または呼び出し元アプリケーションが現在確立しているすべての会話について、トランザクションを有効または無効にします。

戻り値

型: BOOL

関数が成功した場合、戻り値は0以外の値になります。

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

wCmd パラメーターが EC_QUERYWAITING であり、アプリケーションのトランザクションキューに処理中ではない未処理のトランザクションが1件以上ある場合、戻り値は TRUE になります。それ以外の場合は FALSE になります。

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

解説(Remarks)

アプリケーションは、動的データ交換 (DDE) コールバック関数から CBR_BLOCK 戻りコードを返すことで、特定の会話のトランザクションを無効にできます。DdeEnableCallback 関数を使用して会話を再度有効にすると、オペレーティングシステムは、会話が無効にされたときに処理中だったトランザクションと同じトランザクションを生成します。

EC_QUERYWAITING フラグを使用しても、会話の有効状態は変化せず、DdeEnableCallback の呼び出しのコンテキスト内でトランザクションが発行されることもありません。

DdeEnableCallbackEC_QUERYWAITING を指定して呼び出し、関数が0以外の値を返した場合、アプリケーションはメッセージ処理をすばやく許可するか、コールバックから戻るか、コールバックを有効にするようにしてください。このような結果が得られても、以降のコールバックが行われることが保証されるわけではありません。DdeEnableCallbackEC_QUERYWAITING を指定して呼び出すと、コールバックがブロックされているアプリケーションは、ブロックされた会話に保留中のトランザクションがあるかどうかを判定できます。もちろん、このような呼び出しが0を返した場合でも、アプリケーションは常にメッセージを適時に処理するべきです。

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

各言語での呼び出し定義

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

BOOL DdeEnableCallback(
    DWORD idInst,
    HCONV hConv,
    DDE_ENABLE_CALLBACK_CMD wCmd
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool DdeEnableCallback(
    uint idInst,   // DWORD
    IntPtr hConv,   // HCONV
    uint wCmd   // DDE_ENABLE_CALLBACK_CMD
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DdeEnableCallback(
    idInst As UInteger,   ' DWORD
    hConv As IntPtr,   ' HCONV
    wCmd As UInteger   ' DDE_ENABLE_CALLBACK_CMD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' idInst : DWORD
' hConv : HCONV
' wCmd : DDE_ENABLE_CALLBACK_CMD
Declare PtrSafe Function DdeEnableCallback Lib "user32" ( _
    ByVal idInst As Long, _
    ByVal hConv As LongPtr, _
    ByVal wCmd As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DdeEnableCallback = ctypes.windll.user32.DdeEnableCallback
DdeEnableCallback.restype = wintypes.BOOL
DdeEnableCallback.argtypes = [
    wintypes.DWORD,  # idInst : DWORD
    wintypes.HANDLE,  # hConv : HCONV
    wintypes.DWORD,  # wCmd : DDE_ENABLE_CALLBACK_CMD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DdeEnableCallback = Fiddle::Function.new(
  lib['DdeEnableCallback'],
  [
    -Fiddle::TYPE_INT,  # idInst : DWORD
    Fiddle::TYPE_VOIDP,  # hConv : HCONV
    -Fiddle::TYPE_INT,  # wCmd : DDE_ENABLE_CALLBACK_CMD
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn DdeEnableCallback(
        idInst: u32,  // DWORD
        hConv: *mut core::ffi::c_void,  // HCONV
        wCmd: u32  // DDE_ENABLE_CALLBACK_CMD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool DdeEnableCallback(uint idInst, IntPtr hConv, uint wCmd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeEnableCallback' -Namespace Win32 -PassThru
# $api::DdeEnableCallback(idInst, hConv, wCmd)
#uselib "USER32.dll"
#func global DdeEnableCallback "DdeEnableCallback" sptr, sptr, sptr
; DdeEnableCallback idInst, hConv, wCmd   ; 戻り値は stat
; idInst : DWORD -> "sptr"
; hConv : HCONV -> "sptr"
; wCmd : DDE_ENABLE_CALLBACK_CMD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global DdeEnableCallback "DdeEnableCallback" int, sptr, int
; res = DdeEnableCallback(idInst, hConv, wCmd)
; idInst : DWORD -> "int"
; hConv : HCONV -> "sptr"
; wCmd : DDE_ENABLE_CALLBACK_CMD -> "int"
; BOOL DdeEnableCallback(DWORD idInst, HCONV hConv, DDE_ENABLE_CALLBACK_CMD wCmd)
#uselib "USER32.dll"
#cfunc global DdeEnableCallback "DdeEnableCallback" int, intptr, int
; res = DdeEnableCallback(idInst, hConv, wCmd)
; idInst : DWORD -> "int"
; hConv : HCONV -> "intptr"
; wCmd : DDE_ENABLE_CALLBACK_CMD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDdeEnableCallback = user32.NewProc("DdeEnableCallback")
)

// idInst (DWORD), hConv (HCONV), wCmd (DDE_ENABLE_CALLBACK_CMD)
r1, _, err := procDdeEnableCallback.Call(
	uintptr(idInst),
	uintptr(hConv),
	uintptr(wCmd),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DdeEnableCallback(
  idInst: DWORD;   // DWORD
  hConv: THandle;   // HCONV
  wCmd: DWORD   // DDE_ENABLE_CALLBACK_CMD
): BOOL; stdcall;
  external 'USER32.dll' name 'DdeEnableCallback';
result := DllCall("USER32\DdeEnableCallback"
    , "UInt", idInst   ; DWORD
    , "Ptr", hConv   ; HCONV
    , "UInt", wCmd   ; DDE_ENABLE_CALLBACK_CMD
    , "Int")   ; return: BOOL
●DdeEnableCallback(idInst, hConv, wCmd) = DLL("USER32.dll", "bool DdeEnableCallback(dword, void*, dword)")
# 呼び出し: DdeEnableCallback(idInst, hConv, wCmd)
# idInst : DWORD -> "dword"
# hConv : HCONV -> "void*"
# wCmd : DDE_ENABLE_CALLBACK_CMD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn DdeEnableCallback(
    idInst: u32, // DWORD
    hConv: ?*anyopaque, // HCONV
    wCmd: u32 // DDE_ENABLE_CALLBACK_CMD
) callconv(std.os.windows.WINAPI) i32;
proc DdeEnableCallback(
    idInst: uint32,  # DWORD
    hConv: pointer,  # HCONV
    wCmd: uint32  # DDE_ENABLE_CALLBACK_CMD
): int32 {.importc: "DdeEnableCallback", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int DdeEnableCallback(
    uint idInst,   // DWORD
    void* hConv,   // HCONV
    uint wCmd   // DDE_ENABLE_CALLBACK_CMD
);
ccall((:DdeEnableCallback, "USER32.dll"), stdcall, Int32,
      (UInt32, Ptr{Cvoid}, UInt32),
      idInst, hConv, wCmd)
# idInst : DWORD -> UInt32
# hConv : HCONV -> Ptr{Cvoid}
# wCmd : DDE_ENABLE_CALLBACK_CMD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DdeEnableCallback(
    uint32_t idInst,
    void* hConv,
    uint32_t wCmd);
]]
local user32 = ffi.load("user32")
-- user32.DdeEnableCallback(idInst, hConv, wCmd)
-- idInst : DWORD
-- hConv : HCONV
-- wCmd : DDE_ENABLE_CALLBACK_CMD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const DdeEnableCallback = lib.func('__stdcall', 'DdeEnableCallback', 'int32_t', ['uint32_t', 'void *', 'uint32_t']);
// DdeEnableCallback(idInst, hConv, wCmd)
// idInst : DWORD -> 'uint32_t'
// hConv : HCONV -> 'void *'
// wCmd : DDE_ENABLE_CALLBACK_CMD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  DdeEnableCallback: { parameters: ["u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.DdeEnableCallback(idInst, hConv, wCmd)
// idInst : DWORD -> "u32"
// hConv : HCONV -> "pointer"
// wCmd : DDE_ENABLE_CALLBACK_CMD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DdeEnableCallback(
    uint32_t idInst,
    void* hConv,
    uint32_t wCmd);
C, "USER32.dll");
// $ffi->DdeEnableCallback(idInst, hConv, wCmd);
// idInst : DWORD
// hConv : HCONV
// wCmd : DDE_ENABLE_CALLBACK_CMD
// 構造体/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);
    boolean DdeEnableCallback(
        int idInst,   // DWORD
        Pointer hConv,   // HCONV
        int wCmd   // DDE_ENABLE_CALLBACK_CMD
    );
}
@[Link("user32")]
lib LibUSER32
  fun DdeEnableCallback = DdeEnableCallback(
    idInst : UInt32,   # DWORD
    hConv : Void*,   # HCONV
    wCmd : UInt32   # DDE_ENABLE_CALLBACK_CMD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DdeEnableCallbackNative = Int32 Function(Uint32, Pointer<Void>, Uint32);
typedef DdeEnableCallbackDart = int Function(int, Pointer<Void>, int);
final DdeEnableCallback = DynamicLibrary.open('USER32.dll')
    .lookupFunction<DdeEnableCallbackNative, DdeEnableCallbackDart>('DdeEnableCallback');
// idInst : DWORD -> Uint32
// hConv : HCONV -> Pointer<Void>
// wCmd : DDE_ENABLE_CALLBACK_CMD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DdeEnableCallback(
  idInst: DWORD;   // DWORD
  hConv: THandle;   // HCONV
  wCmd: DWORD   // DDE_ENABLE_CALLBACK_CMD
): BOOL; stdcall;
  external 'USER32.dll' name 'DdeEnableCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DdeEnableCallback"
  c_DdeEnableCallback :: Word32 -> Ptr () -> Word32 -> IO CInt
-- idInst : DWORD -> Word32
-- hConv : HCONV -> Ptr ()
-- wCmd : DDE_ENABLE_CALLBACK_CMD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ddeenablecallback =
  foreign "DdeEnableCallback"
    (uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* idInst : DWORD -> uint32_t *)
(* hConv : HCONV -> (ptr void) *)
(* wCmd : DDE_ENABLE_CALLBACK_CMD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("DdeEnableCallback" dde-enable-callback :convention :stdcall) :int32
  (id-inst :uint32)   ; DWORD
  (h-conv :pointer)   ; HCONV
  (w-cmd :uint32))   ; DDE_ENABLE_CALLBACK_CMD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DdeEnableCallback = Win32::API::More->new('USER32',
    'BOOL DdeEnableCallback(DWORD idInst, HANDLE hConv, DWORD wCmd)');
# my $ret = $DdeEnableCallback->Call($idInst, $hConv, $wCmd);
# idInst : DWORD -> DWORD
# hConv : HCONV -> HANDLE
# wCmd : DDE_ENABLE_CALLBACK_CMD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型