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

DdeFreeStringHandle

関数
指定したDDE文字列ハンドルを解放する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL DdeFreeStringHandle(
    DWORD idInst,
    HSZ hsz
);

パラメーター

名前方向説明
idInstDWORDin直前の DdeInitialize 関数の呼び出しによって取得されたアプリケーションインスタンス識別子。
hszHSZin解放する文字列ハンドルへのハンドル。このハンドルは、直前の DdeCreateStringHandle 関数の呼び出しによって作成されたものである必要があります。

戻り値の型: BOOL

公式ドキュメント

呼び出し元アプリケーション内の文字列ハンドルを解放します。

戻り値

型: BOOL

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

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

解説(Remarks)

アプリケーションは、DdeCreateStringHandle で作成した文字列ハンドルを解放できますが、システムがアプリケーションの Dynamic Data Exchange (DDE) コールバック関数に渡したものや、DdeQueryConvInfo 関数によって CONVINFO 構造体で返されたものは解放しないでください。

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

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('USER32.dll')
DdeFreeStringHandle = Fiddle::Function.new(
  lib['DdeFreeStringHandle'],
  [
    -Fiddle::TYPE_INT,  # idInst : DWORD
    Fiddle::TYPE_VOIDP,  # hsz : HSZ
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn DdeFreeStringHandle(
        idInst: u32,  // DWORD
        hsz: *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 DdeFreeStringHandle(uint idInst, IntPtr hsz);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DdeFreeStringHandle' -Namespace Win32 -PassThru
# $api::DdeFreeStringHandle(idInst, hsz)
#uselib "USER32.dll"
#func global DdeFreeStringHandle "DdeFreeStringHandle" sptr, sptr
; DdeFreeStringHandle idInst, hsz   ; 戻り値は stat
; idInst : DWORD -> "sptr"
; hsz : HSZ -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global DdeFreeStringHandle "DdeFreeStringHandle" int, sptr
; res = DdeFreeStringHandle(idInst, hsz)
; idInst : DWORD -> "int"
; hsz : HSZ -> "sptr"
; BOOL DdeFreeStringHandle(DWORD idInst, HSZ hsz)
#uselib "USER32.dll"
#cfunc global DdeFreeStringHandle "DdeFreeStringHandle" int, intptr
; res = DdeFreeStringHandle(idInst, hsz)
; idInst : DWORD -> "int"
; hsz : HSZ -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDdeFreeStringHandle = user32.NewProc("DdeFreeStringHandle")
)

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

extern "user32" fn DdeFreeStringHandle(
    idInst: u32, // DWORD
    hsz: ?*anyopaque // HSZ
) callconv(std.os.windows.WINAPI) i32;
proc DdeFreeStringHandle(
    idInst: uint32,  # DWORD
    hsz: pointer  # HSZ
): int32 {.importc: "DdeFreeStringHandle", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int DdeFreeStringHandle(
    uint idInst,   // DWORD
    void* hsz   // HSZ
);
ccall((:DdeFreeStringHandle, "USER32.dll"), stdcall, Int32,
      (UInt32, Ptr{Cvoid}),
      idInst, hsz)
# idInst : DWORD -> UInt32
# hsz : HSZ -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DdeFreeStringHandle(
    uint32_t idInst,
    void* hsz);
]]
local user32 = ffi.load("user32")
-- user32.DdeFreeStringHandle(idInst, hsz)
-- idInst : DWORD
-- hsz : HSZ
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const DdeFreeStringHandle = lib.func('__stdcall', 'DdeFreeStringHandle', 'int32_t', ['uint32_t', 'void *']);
// DdeFreeStringHandle(idInst, hsz)
// idInst : DWORD -> 'uint32_t'
// hsz : HSZ -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  DdeFreeStringHandle: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.DdeFreeStringHandle(idInst, hsz)
// idInst : DWORD -> "u32"
// hsz : HSZ -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DdeFreeStringHandle(
    uint32_t idInst,
    void* hsz);
C, "USER32.dll");
// $ffi->DdeFreeStringHandle(idInst, hsz);
// idInst : DWORD
// hsz : 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 DdeFreeStringHandle(
        int idInst,   // DWORD
        Pointer hsz   // HSZ
    );
}
@[Link("user32")]
lib LibUSER32
  fun DdeFreeStringHandle = DdeFreeStringHandle(
    idInst : UInt32,   # DWORD
    hsz : 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 DdeFreeStringHandleNative = Int32 Function(Uint32, Pointer<Void>);
typedef DdeFreeStringHandleDart = int Function(int, Pointer<Void>);
final DdeFreeStringHandle = DynamicLibrary.open('USER32.dll')
    .lookupFunction<DdeFreeStringHandleNative, DdeFreeStringHandleDart>('DdeFreeStringHandle');
// idInst : DWORD -> Uint32
// hsz : HSZ -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DdeFreeStringHandle(
  idInst: DWORD;   // DWORD
  hsz: THandle   // HSZ
): BOOL; stdcall;
  external 'USER32.dll' name 'DdeFreeStringHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let ddefreestringhandle =
  foreign "DdeFreeStringHandle"
    (uint32_t @-> (ptr void) @-> returning int32_t)
(* idInst : DWORD -> uint32_t *)
(* hsz : 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 ("DdeFreeStringHandle" dde-free-string-handle :convention :stdcall) :int32
  (id-inst :uint32)   ; DWORD
  (hsz :pointer))   ; HSZ
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DdeFreeStringHandle = Win32::API::More->new('USER32',
    'BOOL DdeFreeStringHandle(DWORD idInst, HANDLE hsz)');
# my $ret = $DdeFreeStringHandle->Call($idInst, $hsz);
# idInst : DWORD -> DWORD
# hsz : HSZ -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目