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

VarBoolFromStr

関数
ロケールを指定して文字列をVARIANT_BOOL型に変換する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarBoolFromStr(
    LPCWSTR strIn,
    DWORD lcid,
    DWORD dwFlags,
    VARIANT_BOOL* pboolOut
);

パラメーター

名前方向説明
strInLPCWSTRin変換する値。
lcidDWORDinロケール識別子。
dwFlagsDWORDin

次のフラグの 1 つ以上。

Value Meaning
LOCALE_NOUSEROVERRIDE
カスタムロケール設定ではなく、システム既定のロケール設定を使用します。
VAR_LOCALBOOL
ローカライズされた Boolean 名を使用します。
pboolOutVARIANT_BOOL*out変換結果の値。

戻り値の型: HRESULT

公式ドキュメント

OLECHAR 文字列を Boolean 値に変換します。

戻り値

この関数は次のいずれかの値を返します。

Return code Description
S_OK
成功しました。
DISP_E_BADVARTYPE
入力パラメーターが有効な variant の型ではありません。
DISP_E_OVERFLOW
出力パラメーターが指すデータが変換先の型に収まりません。
DISP_E_TYPEMISMATCH
引数を指定された型に強制変換できませんでした。
E_INVALIDARG
引数のいずれかが有効ではありません。
E_OUTOFMEMORY
操作を完了するためのメモリが不足しています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT VarBoolFromStr(
    LPCWSTR strIn,
    DWORD lcid,
    DWORD dwFlags,
    VARIANT_BOOL* pboolOut
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarBoolFromStr(
    [MarshalAs(UnmanagedType.LPWStr)] string strIn,   // LPCWSTR
    uint lcid,   // DWORD
    uint dwFlags,   // DWORD
    out short pboolOut   // VARIANT_BOOL* out
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarBoolFromStr(
    <MarshalAs(UnmanagedType.LPWStr)> strIn As String,   ' LPCWSTR
    lcid As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef pboolOut As Short   ' VARIANT_BOOL* out
) As Integer
End Function
' strIn : LPCWSTR
' lcid : DWORD
' dwFlags : DWORD
' pboolOut : VARIANT_BOOL* out
Declare PtrSafe Function VarBoolFromStr Lib "oleaut32" ( _
    ByVal strIn As LongPtr, _
    ByVal lcid As Long, _
    ByVal dwFlags As Long, _
    ByRef pboolOut As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

VarBoolFromStr = ctypes.windll.oleaut32.VarBoolFromStr
VarBoolFromStr.restype = ctypes.c_int
VarBoolFromStr.argtypes = [
    wintypes.LPCWSTR,  # strIn : LPCWSTR
    wintypes.DWORD,  # lcid : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pboolOut : VARIANT_BOOL* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procVarBoolFromStr = oleaut32.NewProc("VarBoolFromStr")
)

// strIn (LPCWSTR), lcid (DWORD), dwFlags (DWORD), pboolOut (VARIANT_BOOL* out)
r1, _, err := procVarBoolFromStr.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(strIn))),
	uintptr(lcid),
	uintptr(dwFlags),
	uintptr(pboolOut),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function VarBoolFromStr(
  strIn: PWideChar;   // LPCWSTR
  lcid: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  pboolOut: Pointer   // VARIANT_BOOL* out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'VarBoolFromStr';
result := DllCall("OLEAUT32\VarBoolFromStr"
    , "WStr", strIn   ; LPCWSTR
    , "UInt", lcid   ; DWORD
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pboolOut   ; VARIANT_BOOL* out
    , "Int")   ; return: HRESULT
●VarBoolFromStr(strIn, lcid, dwFlags, pboolOut) = DLL("OLEAUT32.dll", "int VarBoolFromStr(char*, dword, dword, void*)")
# 呼び出し: VarBoolFromStr(strIn, lcid, dwFlags, pboolOut)
# strIn : LPCWSTR -> "char*"
# lcid : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# pboolOut : VARIANT_BOOL* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef VarBoolFromStrNative = Int32 Function(Pointer<Utf16>, Uint32, Uint32, Pointer<Int16>);
typedef VarBoolFromStrDart = int Function(Pointer<Utf16>, int, int, Pointer<Int16>);
final VarBoolFromStr = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<VarBoolFromStrNative, VarBoolFromStrDart>('VarBoolFromStr');
// strIn : LPCWSTR -> Pointer<Utf16>
// lcid : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// pboolOut : VARIANT_BOOL* out -> Pointer<Int16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VarBoolFromStr(
  strIn: PWideChar;   // LPCWSTR
  lcid: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD
  pboolOut: Pointer   // VARIANT_BOOL* out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'VarBoolFromStr';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VarBoolFromStr"
  c_VarBoolFromStr :: CWString -> Word32 -> Word32 -> Ptr Int16 -> IO Int32
-- strIn : LPCWSTR -> CWString
-- lcid : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- pboolOut : VARIANT_BOOL* out -> Ptr Int16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let varboolfromstr =
  foreign "VarBoolFromStr"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr int16_t) @-> returning int32_t)
(* strIn : LPCWSTR -> (ptr uint16_t) *)
(* lcid : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* pboolOut : VARIANT_BOOL* out -> (ptr int16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("VarBoolFromStr" var-bool-from-str :convention :stdcall) :int32
  (str-in (:string :encoding :utf-16le))   ; LPCWSTR
  (lcid :uint32)   ; DWORD
  (dw-flags :uint32)   ; DWORD
  (pbool-out :pointer))   ; VARIANT_BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VarBoolFromStr = Win32::API::More->new('OLEAUT32',
    'int VarBoolFromStr(LPCWSTR strIn, DWORD lcid, DWORD dwFlags, LPVOID pboolOut)');
# my $ret = $VarBoolFromStr->Call($strIn, $lcid, $dwFlags, $pboolOut);
# strIn : LPCWSTR -> LPCWSTR
# lcid : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# pboolOut : VARIANT_BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。