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

DdePostAdvise

関数
DDEサーバーがアドバイズループでデータ更新を通知する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL DdePostAdvise(
    DWORD idInst,
    HSZ hszTopic,
    HSZ hszItem
);

パラメーター

名前方向説明
idInstDWORDin以前の DdeInitialize 関数の呼び出しで取得したアプリケーションインスタンス識別子です。
hszTopicHSZinトピック名を指定する文字列へのハンドルです。アクティブなアドバイズループを持つすべてのトピックに通知を送信するには、アプリケーションはこのパラメーターを 0L に設定できます。
hszItemHSZinアイテム名を指定する文字列へのハンドルです。アクティブなアドバイズループを持つすべてのアイテムに通知を送信するには、アプリケーションはこのパラメーターを 0L に設定できます。

戻り値の型: BOOL

公式ドキュメント

指定したトピックとアイテムに対してアクティブなアドバイズループを持つ各クライアントについて、呼び出し元(サーバー)アプリケーションの動的データ交換(DDE)コールバック関数に XTYP_ADVREQ トランザクションを送信するようシステムに指示します。

戻り値

型: BOOL

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

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

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

解説(Remarks)

列挙不可能なトピックまたはアイテムを持つサーバーは、 hszTopic パラメーターと hszItem パラメーターを NULL に設定し、システムがすべてのアクティブなアドバイズループに対してトランザクションを生成するようにする必要があります。サーバーの DDE コールバック関数は、更新すべきでないアドバイズループに対しては NULL を返します。

サーバーが、現在 XTYP_ADVREQ コールバックで処理中のセットを含むトピック、アイテム、フォーマット名のセットを指定して DdePostAdvise を呼び出すと、スタックオーバーフローが発生する可能性があります。

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

各言語での呼び出し定義

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

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

DdePostAdvise = ctypes.windll.user32.DdePostAdvise
DdePostAdvise.restype = wintypes.BOOL
DdePostAdvise.argtypes = [
    wintypes.DWORD,  # idInst : DWORD
    wintypes.HANDLE,  # hszTopic : HSZ
    wintypes.HANDLE,  # hszItem : HSZ
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDdePostAdvise = user32.NewProc("DdePostAdvise")
)

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

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

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

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

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

(cffi:defcfun ("DdePostAdvise" dde-post-advise :convention :stdcall) :int32
  (id-inst :uint32)   ; DWORD
  (hsz-topic :pointer)   ; HSZ
  (hsz-item :pointer))   ; HSZ
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DdePostAdvise = Win32::API::More->new('USER32',
    'BOOL DdePostAdvise(DWORD idInst, HANDLE hszTopic, HANDLE hszItem)');
# my $ret = $DdePostAdvise->Call($idInst, $hszTopic, $hszItem);
# idInst : DWORD -> DWORD
# hszTopic : HSZ -> HANDLE
# hszItem : HSZ -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目