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

DdeSetUserHandle

関数
DDE会話にアプリケーション定義のユーザーハンドルを関連付ける。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL DdeSetUserHandle(
    HCONV hConv,
    DWORD id,
    UINT_PTR hUser
);

パラメーター

名前方向説明
hConvHCONVin会話へのハンドルです。
idDWORDinhUser パラメーターで指定された値に関連付けるトランザクション識別子です。hUserhConv パラメーターで識別される会話に関連付けるには、アプリケーションはこのパラメーターを QID_SYNC に設定する必要があります。
hUserUINT_PTRin会話ハンドルに関連付ける値です。

戻り値の型: BOOL

公式ドキュメント

アプリケーション定義の値を会話ハンドルまたはトランザクション識別子に関連付けます。これは非同期トランザクションの処理を簡素化するのに役立ちます。アプリケーションは DdeQueryConvInfo 関数を使用してこの値を取得できます。

戻り値

型: BOOL

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

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

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

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

各言語での呼び出し定義

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

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

DdeSetUserHandle = ctypes.windll.user32.DdeSetUserHandle
DdeSetUserHandle.restype = wintypes.BOOL
DdeSetUserHandle.argtypes = [
    wintypes.HANDLE,  # hConv : HCONV
    wintypes.DWORD,  # id : DWORD
    ctypes.c_size_t,  # hUser : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDdeSetUserHandle = user32.NewProc("DdeSetUserHandle")
)

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

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

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

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

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

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

関連項目

公式の関連項目