VariantToBoolean

関数

VARIANTをブール値へ変換して取得する。

DLLPROPSYS.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT VariantToBoolean(
    const VARIANT* varIn,
    BOOL* pfRet
);

パラメーター

名前	型	方向	説明
varIn	VARIANT*	in	変換元の VARIANT 構造体への参照。
pfRet	BOOL*	out	この関数が戻るときに、取り出された値が存在する場合はその値が格納されます。存在しない場合は FALSE が格納されます。

戻り値の型: HRESULT

公式ドキュメント

VARIANT 構造体から Boolean 型のプロパティの値を取り出します。値を取り出せない場合は、既定値が設定されます。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このヘルパー関数は、呼び出し元のアプリケーションが VARIANT 構造体に Boolean 値が格納されていることを想定している場合に使用します。たとえば、シェルフォルダーから値を取得するアプリケーションは、この関数を使用して、フォルダーの Boolean 型プロパティの 1 つから値を安全に取り出すことができます。

変換元の VARIANT が VT_BOOL 型である場合、この関数は BOOL 値を取り出します。

変換元の VARIANT が VT_BOOL 型でない場合、この関数は VARIANT 構造体内の値を BOOL に変換しようとします。変換できない場合、VariantToBoolean は失敗コードを返し、pfRet に FALSE を設定します。変換可能な組み合わせの一覧については、PropVariantChangeType を参照してください。なお、VT_EMPTY は FALSE に正常に変換されます。

例

次の例は、より大きなプログラムの一部として使用することを想定しており、VariantToBoolean を使用して VARIANT 内の BOOL 値にアクセスする方法を示しています。

// VARIANT var;
// 変数 var は初期化済みで有効であるものとします。
// アプリケーションは、そこに VT_BOOL 値が格納されていることを想定しています。
BOOL fValue;

HRESULT hr = VariantToBoolean(var, &fValue);

if (SUCCEEDED(hr))
{
    // fValue は有効な値になります。
}
else
{
    // fValue は常に FALSE です。
}

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

各言語での呼び出し定義

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

HRESULT VariantToBoolean(
    const VARIANT* varIn,
    BOOL* pfRet
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int VariantToBoolean(
    IntPtr varIn,   // VARIANT*
    out bool pfRet   // BOOL* out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function VariantToBoolean(
    varIn As IntPtr,   ' VARIANT*
    <Out> ByRef pfRet As Boolean   ' BOOL* out
) As Integer
End Function

' varIn : VARIANT*
' pfRet : BOOL* out
Declare PtrSafe Function VariantToBoolean Lib "propsys" ( _
    ByVal varIn As LongPtr, _
    ByRef pfRet As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VariantToBoolean = ctypes.windll.propsys.VariantToBoolean
VariantToBoolean.restype = ctypes.c_int
VariantToBoolean.argtypes = [
    ctypes.c_void_p,  # varIn : VARIANT*
    ctypes.c_void_p,  # pfRet : BOOL* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
VariantToBoolean = Fiddle::Function.new(
  lib['VariantToBoolean'],
  [
    Fiddle::TYPE_VOIDP,  # varIn : VARIANT*
    Fiddle::TYPE_VOIDP,  # pfRet : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "propsys")]
extern "system" {
    fn VariantToBoolean(
        varIn: *const VARIANT,  // VARIANT*
        pfRet: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PROPSYS.dll")]
public static extern int VariantToBoolean(IntPtr varIn, out bool pfRet);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_VariantToBoolean' -Namespace Win32 -PassThru
# $api::VariantToBoolean(varIn, pfRet)

#uselib "PROPSYS.dll"
#func global VariantToBoolean "VariantToBoolean" sptr, sptr
; VariantToBoolean varptr(varIn), varptr(pfRet)   ; 戻り値は stat
; varIn : VARIANT* -> "sptr"
; pfRet : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "PROPSYS.dll"
#cfunc global VariantToBoolean "VariantToBoolean" var, var
; res = VariantToBoolean(varIn, pfRet)
; varIn : VARIANT* -> "var"
; pfRet : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "PROPSYS.dll"
#cfunc global VariantToBoolean "VariantToBoolean" sptr, sptr
; res = VariantToBoolean(varptr(varIn), varptr(pfRet))
; varIn : VARIANT* -> "sptr"
; pfRet : BOOL* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。