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

DdeCmpStringHandles

関数
2つのDDE文字列ハンドルが指す文字列を比較する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT DdeCmpStringHandles(
    HSZ hsz1,
    HSZ hsz2
);

パラメーター

名前方向説明
hsz1HSZin1 番目の文字列へのハンドル。
hsz2HSZin2 番目の文字列へのハンドル。

戻り値の型: INT

公式ドキュメント

2 つの文字列ハンドルの値を比較します。文字列ハンドルの値は、関連付けられた文字列の大文字小文字とは関係ありません。

戻り値

Type: int

戻り値は次の値のいずれかになります。

戻り値 説明
-1
hsz1 の値が 0 であるか、hsz2 の値より小さい。
0
hsz1hsz2 の値が等しい(両方とも 0 の場合もあります)。
1
hsz2 の値が 0 であるか、hsz1 の値より小さい。

解説(Remarks)

2 つの文字列ハンドルを大文字小文字を区別して比較する必要があるアプリケーションは、文字列ハンドルを直接比較してください。それ以外のすべての比較では、DdeCmpStringHandles を使用して、Dynamic Data Exchange (DDE) の大文字小文字を区別しない性質を維持してください。

DdeCmpStringHandles は、文字列ハンドルをアルファベット順にソートする目的では使用できません。

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

各言語での呼び出し定義

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

INT DdeCmpStringHandles(
    HSZ hsz1,
    HSZ hsz2
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern int DdeCmpStringHandles(
    IntPtr hsz1,   // HSZ
    IntPtr hsz2   // HSZ
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DdeCmpStringHandles(
    hsz1 As IntPtr,   ' HSZ
    hsz2 As IntPtr   ' HSZ
) As Integer
End Function
' hsz1 : HSZ
' hsz2 : HSZ
Declare PtrSafe Function DdeCmpStringHandles Lib "user32" ( _
    ByVal hsz1 As LongPtr, _
    ByVal hsz2 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DdeCmpStringHandles = ctypes.windll.user32.DdeCmpStringHandles
DdeCmpStringHandles.restype = ctypes.c_int
DdeCmpStringHandles.argtypes = [
    wintypes.HANDLE,  # hsz1 : HSZ
    wintypes.HANDLE,  # hsz2 : HSZ
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDdeCmpStringHandles = user32.NewProc("DdeCmpStringHandles")
)

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

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

foreign import stdcall safe "DdeCmpStringHandles"
  c_DdeCmpStringHandles :: Ptr () -> Ptr () -> IO Int32
-- hsz1 : HSZ -> Ptr ()
-- hsz2 : HSZ -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

公式の関連項目