ホーム › System.Com.StructuredStorage › PropVariantToDoubleVector

PropVariantToDoubleVector

関数

PROPVARIANTから倍精度浮動小数点の配列を取り出す。

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

シグネチャ

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

HRESULT PropVariantToDoubleVector(
    const PROPVARIANT* propvar,
    DOUBLE* prgn,
    DWORD crgn,
    DWORD* pcElem
);

パラメーター

名前	型	方向	説明
propvar	PROPVARIANT*	in	ソースとなる PROPVARIANT 構造体への参照です。
prgn	DOUBLE*	out	crgn 個の DOUBLE 値を格納できるバッファーを指します。この関数から制御が戻るとき、このバッファーにはソースの PROPVARIANT 構造体から抽出された pcElem 個の double 要素が設定されています。
crgn	DWORD	in	prgn が指すバッファーのサイズ (要素数) です。
pcElem	DWORD*	out	この関数から制御が戻るとき、ソースの PROPVARIANT 構造体から抽出された double 要素の数が格納されます。

戻り値の型: HRESULT

公式ドキュメント

PROPVARIANT 構造体から double のベクターを抽出します。

戻り値

型: HRESULT

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

解説(Remarks)

このヘルパー関数は、呼び出し側アプリケーションが PROPVARIANT に要素数が固定された double のベクター値が格納されていることを想定している場面で使用します。

ソースの PROPVARIANT の型が VT_VECTOR | VT_R8 または VT_ARRAY | VT_R8 の場合、このヘルパー関数は最大 crgn 個の double 値を抽出し、prgn が指すバッファーに格納します。PROPVARIANT に prgn バッファーへ収まらない数の要素が含まれている場合、この関数はエラーを返し、pcElem に 0 を設定します。

例

// IPropertyStore *ppropstore;
// 変数 ppropstore は初期化済みで有効であるものとします
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_GPS_DestLongitude, &propvar);
if (SUCCEEDED(hr))
{
         // PKEY_GPS_DestLongitude は 3 つの値を持つ VT_VECTOR | VT_R8、または VT_EMPTY を返すことが想定されます
         // PropVariantToDoubleVector は VT_EMPTY に対してはエラーを返します
         DOUBLE rgLongitude[3];
         ULONG cElem;
         hr = PropVariantToDoubleVector(propvar, &rgLongitude, ARRAYSIZE(rgLongitude), &cElem);
         if (SUCCEEDED(hr))
         {
                 if (cElem == ARRAYSIZE(rgLongitude))
                 {
                          // rgLongitude には経度の度・分・秒を表す 3 つの double が格納されています
                 }
                 else
                 {
                          // propvar の先頭 cElem 個の double が rgLongitude の先頭 3 要素に格納されます
         }
         else
         {
                 // propvar は VT_EMPTY であるか、3 つの double のベクター以外のものを含んでいます
         }
         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 PropVariantToDoubleVector(
    const PROPVARIANT* propvar,
    DOUBLE* prgn,
    DWORD crgn,
    DWORD* pcElem
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int PropVariantToDoubleVector(
    IntPtr propvar,   // PROPVARIANT*
    out double prgn,   // DOUBLE* out
    uint crgn,   // DWORD
    out uint pcElem   // DWORD* out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function PropVariantToDoubleVector(
    propvar As IntPtr,   ' PROPVARIANT*
    <Out> ByRef prgn As Double,   ' DOUBLE* out
    crgn As UInteger,   ' DWORD
    <Out> ByRef pcElem As UInteger   ' DWORD* out
) As Integer
End Function

' propvar : PROPVARIANT*
' prgn : DOUBLE* out
' crgn : DWORD
' pcElem : DWORD* out
Declare PtrSafe Function PropVariantToDoubleVector Lib "propsys" ( _
    ByVal propvar As LongPtr, _
    ByRef prgn As Double, _
    ByVal crgn As Long, _
    ByRef pcElem As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PropVariantToDoubleVector = ctypes.windll.propsys.PropVariantToDoubleVector
PropVariantToDoubleVector.restype = ctypes.c_int
PropVariantToDoubleVector.argtypes = [
    ctypes.c_void_p,  # propvar : PROPVARIANT*
    ctypes.POINTER(ctypes.c_double),  # prgn : DOUBLE* out
    wintypes.DWORD,  # crgn : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcElem : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
PropVariantToDoubleVector = Fiddle::Function.new(
  lib['PropVariantToDoubleVector'],
  [
    Fiddle::TYPE_VOIDP,  # propvar : PROPVARIANT*
    Fiddle::TYPE_VOIDP,  # prgn : DOUBLE* out
    -Fiddle::TYPE_INT,  # crgn : DWORD
    Fiddle::TYPE_VOIDP,  # pcElem : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "propsys")]
extern "system" {
    fn PropVariantToDoubleVector(
        propvar: *const PROPVARIANT,  // PROPVARIANT*
        prgn: *mut f64,  // DOUBLE* out
        crgn: u32,  // DWORD
        pcElem: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PROPSYS.dll")]
public static extern int PropVariantToDoubleVector(IntPtr propvar, out double prgn, uint crgn, out uint pcElem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_PropVariantToDoubleVector' -Namespace Win32 -PassThru
# $api::PropVariantToDoubleVector(propvar, prgn, crgn, pcElem)

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

出力引数:

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