ホーム › System.Com.StructuredStorage › PropVariantToInt16

PropVariantToInt16

関数

PROPVARIANTを16ビット整数へ変換して取得する。

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

シグネチャ

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

HRESULT PropVariantToInt16(
    const PROPVARIANT* propvarIn,
    SHORT* piRet
);

パラメーター

名前	型	方向	説明
propvarIn	PROPVARIANT*	in	変換元となる PROPVARIANT 構造体への参照です。
piRet	SHORT*	out	この関数から制御が戻るとき、抽出されたプロパティ値が格納されます。値が存在しない場合は 0 が格納されます。

戻り値の型: HRESULT

公式ドキュメント

PROPVARIANT 構造体から Int16 のプロパティ値を抽出します。

戻り値

型: HRESULT

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

解説(Remarks)

このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT に Int16 値が格納されていることを前提としている場面で使用します。たとえば、プロパティストアから値を取得するアプリケーションは、この関数を使用して Int16 プロパティの Int16 値を安全に抽出できます。

変換元の PROPVARIANT の型が VT_I2 の場合、このヘルパー関数は Int16 値を抽出します。それ以外の場合は、PROPVARIANT 構造体内の値を Int16 に変換しようとします。変換できない場合、PropVariantToInt16 は失敗コードを返し、piRet に 0 を設定します。変換可能な組み合わせの一覧については、PropVariantChangeType を参照してください。なお、VT_EMPTY は 0 に正常に変換されます。

例

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

// IPropertyStore *ppropstore;

// 変数 ppropstore は初期化済みで有効であるものとします

PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_Image_ResolutionUnit, &propvar);

if (SUCCEEDED(hr))

{

     // PKEY_Image_ResolutionUnit は VT_I2 または VT_EMPTY の値を返すことが想定されます。

     // PropVariantToInt16 は VT_EMPTY を 0 に変換します。

     INT16 iUnit;

     hr = PropVariantToInt16(propvar, & iUnit);

     if (SUCCEEDED(hr))

     {

             // iUnit は有効な値です

     }

     else

     {

             // iUnit は常に 0 です

     }

     PropVariantClear(&propvar);

}

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

各言語での呼び出し定義

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

HRESULT PropVariantToInt16(
    const PROPVARIANT* propvarIn,
    SHORT* piRet
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PropVariantToInt16(
    IntPtr propvarIn,   // PROPVARIANT*
    out short piRet   // SHORT* out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PropVariantToInt16(
    propvarIn As IntPtr,   ' PROPVARIANT*
    <Out> ByRef piRet As Short   ' SHORT* out
) As Integer
End Function

' propvarIn : PROPVARIANT*
' piRet : SHORT* out
Declare PtrSafe Function PropVariantToInt16 Lib "propsys" ( _
    ByVal propvarIn As LongPtr, _
    ByRef piRet As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PropVariantToInt16 = ctypes.windll.propsys.PropVariantToInt16
PropVariantToInt16.restype = ctypes.c_int
PropVariantToInt16.argtypes = [
    ctypes.c_void_p,  # propvarIn : PROPVARIANT*
    ctypes.POINTER(ctypes.c_short),  # piRet : SHORT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
PropVariantToInt16 = Fiddle::Function.new(
  lib['PropVariantToInt16'],
  [
    Fiddle::TYPE_VOIDP,  # propvarIn : PROPVARIANT*
    Fiddle::TYPE_VOIDP,  # piRet : SHORT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "propsys")]
extern "system" {
    fn PropVariantToInt16(
        propvarIn: *const PROPVARIANT,  // PROPVARIANT*
        piRet: *mut i16  // SHORT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PROPSYS.dll")]
public static extern int PropVariantToInt16(IntPtr propvarIn, out short piRet);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_PropVariantToInt16' -Namespace Win32 -PassThru
# $api::PropVariantToInt16(propvarIn, piRet)

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

出力引数:

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