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

VarCmp

関数
2つのVARIANT値をロケール指定で比較する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

VARCMP VarCmp(
    VARIANT* pvarLeft,
    VARIANT* pvarRight,
    DWORD lcid,
    DWORD dwFlags
);

パラメーター

名前方向説明
pvarLeftVARIANT*in1 つ目のバリアント。
pvarRightVARIANT*in2 つ目のバリアント。
lcidDWORDinロケール識別子。
dwFlagsDWORDin

比較結果のオプション。

意味
NORM_IGNORECASE
0x00000001
大文字と小文字を区別しません。
NORM_IGNORENONSPACE
0x00000002
非スペース文字を無視します。
NORM_IGNORESYMBOLS
0x00000004
記号を無視します。
NORM_IGNOREWIDTH
0x00000008
文字幅を無視します。
NORM_IGNOREKANATYPE
0x00000040
かなの種類を無視します。
NORM_IGNOREKASHIDA
0x00040000
アラビア語の kashida 文字を無視します。

戻り値の型: VARCMP

公式ドキュメント

2 つのバリアントを比較します。

戻り値

この関数は、次のいずれかの値を返すことがあります。

リターン コード/値 説明
VARCMP_LT
0
pvarLeftpvarRight より小さいです。
VARCMP_EQ
1
パラメーターは等しいです。
VARCMP_GT
2
pvarLeftpvarRight より大きいです。
VARCMP_NULL
3
いずれかの式が NULL です。

解説(Remarks)

この関数はバリアント型の値のみを比較します。文字列、整数、浮動小数点数は比較しますが、配列やレコードは比較しません。

NORM_IGNOREWIDTH を指定すると、次の例に示すように、VarCmp は半角文字と全角文字の違いを無視します。

"Cat"== "cat"

全角形式は、中国語および日本語の文字体系で使用される書式上の区別です。

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

各言語での呼び出し定義

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

VARCMP VarCmp(
    VARIANT* pvarLeft,
    VARIANT* pvarRight,
    DWORD lcid,
    DWORD dwFlags
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern uint VarCmp(
    IntPtr pvarLeft,   // VARIANT*
    IntPtr pvarRight,   // VARIANT*
    uint lcid,   // DWORD
    uint dwFlags   // DWORD
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarCmp(
    pvarLeft As IntPtr,   ' VARIANT*
    pvarRight As IntPtr,   ' VARIANT*
    lcid As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function
' pvarLeft : VARIANT*
' pvarRight : VARIANT*
' lcid : DWORD
' dwFlags : DWORD
Declare PtrSafe Function VarCmp Lib "oleaut32" ( _
    ByVal pvarLeft As LongPtr, _
    ByVal pvarRight As LongPtr, _
    ByVal lcid As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

VarCmp = ctypes.windll.oleaut32.VarCmp
VarCmp.restype = wintypes.DWORD
VarCmp.argtypes = [
    ctypes.c_void_p,  # pvarLeft : VARIANT*
    ctypes.c_void_p,  # pvarRight : VARIANT*
    wintypes.DWORD,  # lcid : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarCmp = Fiddle::Function.new(
  lib['VarCmp'],
  [
    Fiddle::TYPE_VOIDP,  # pvarLeft : VARIANT*
    Fiddle::TYPE_VOIDP,  # pvarRight : VARIANT*
    -Fiddle::TYPE_INT,  # lcid : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "oleaut32")]
extern "system" {
    fn VarCmp(
        pvarLeft: *mut VARIANT,  // VARIANT*
        pvarRight: *mut VARIANT,  // VARIANT*
        lcid: u32,  // DWORD
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern uint VarCmp(IntPtr pvarLeft, IntPtr pvarRight, uint lcid, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarCmp' -Namespace Win32 -PassThru
# $api::VarCmp(pvarLeft, pvarRight, lcid, dwFlags)
#uselib "OLEAUT32.dll"
#func global VarCmp "VarCmp" sptr, sptr, sptr, sptr
; VarCmp varptr(pvarLeft), varptr(pvarRight), lcid, dwFlags   ; 戻り値は stat
; pvarLeft : VARIANT* -> "sptr"
; pvarRight : VARIANT* -> "sptr"
; lcid : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLEAUT32.dll"
#cfunc global VarCmp "VarCmp" var, var, int, int
; res = VarCmp(pvarLeft, pvarRight, lcid, dwFlags)
; pvarLeft : VARIANT* -> "var"
; pvarRight : VARIANT* -> "var"
; lcid : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; VARCMP VarCmp(VARIANT* pvarLeft, VARIANT* pvarRight, DWORD lcid, DWORD dwFlags)
#uselib "OLEAUT32.dll"
#cfunc global VarCmp "VarCmp" var, var, int, int
; res = VarCmp(pvarLeft, pvarRight, lcid, dwFlags)
; pvarLeft : VARIANT* -> "var"
; pvarRight : VARIANT* -> "var"
; lcid : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procVarCmp = oleaut32.NewProc("VarCmp")
)

// pvarLeft (VARIANT*), pvarRight (VARIANT*), lcid (DWORD), dwFlags (DWORD)
r1, _, err := procVarCmp.Call(
	uintptr(pvarLeft),
	uintptr(pvarRight),
	uintptr(lcid),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // VARCMP
function VarCmp(
  pvarLeft: Pointer;   // VARIANT*
  pvarRight: Pointer;   // VARIANT*
  lcid: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'OLEAUT32.dll' name 'VarCmp';
result := DllCall("OLEAUT32\VarCmp"
    , "Ptr", pvarLeft   ; VARIANT*
    , "Ptr", pvarRight   ; VARIANT*
    , "UInt", lcid   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "UInt")   ; return: VARCMP
●VarCmp(pvarLeft, pvarRight, lcid, dwFlags) = DLL("OLEAUT32.dll", "dword VarCmp(void*, void*, dword, dword)")
# 呼び出し: VarCmp(pvarLeft, pvarRight, lcid, dwFlags)
# pvarLeft : VARIANT* -> "void*"
# pvarRight : VARIANT* -> "void*"
# lcid : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef VarCmpNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Uint32);
typedef VarCmpDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final VarCmp = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<VarCmpNative, VarCmpDart>('VarCmp');
// pvarLeft : VARIANT* -> Pointer<Void>
// pvarRight : VARIANT* -> Pointer<Void>
// lcid : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VarCmp(
  pvarLeft: Pointer;   // VARIANT*
  pvarRight: Pointer;   // VARIANT*
  lcid: DWORD;   // DWORD
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'OLEAUT32.dll' name 'VarCmp';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VarCmp"
  c_VarCmp :: Ptr () -> Ptr () -> Word32 -> Word32 -> IO Word32
-- pvarLeft : VARIANT* -> Ptr ()
-- pvarRight : VARIANT* -> Ptr ()
-- lcid : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let varcmp =
  foreign "VarCmp"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* pvarLeft : VARIANT* -> (ptr void) *)
(* pvarRight : VARIANT* -> (ptr void) *)
(* lcid : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("VarCmp" var-cmp :convention :stdcall) :uint32
  (pvar-left :pointer)   ; VARIANT*
  (pvar-right :pointer)   ; VARIANT*
  (lcid :uint32)   ; DWORD
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VarCmp = Win32::API::More->new('OLEAUT32',
    'DWORD VarCmp(LPVOID pvarLeft, LPVOID pvarRight, DWORD lcid, DWORD dwFlags)');
# my $ret = $VarCmp->Call($pvarLeft, $pvarRight, $lcid, $dwFlags);
# pvarLeft : VARIANT* -> LPVOID
# pvarRight : VARIANT* -> LPVOID
# lcid : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型