ホーム › UI.Shell › InitVariantFromStrRet

InitVariantFromStrRet

関数

STRRET構造体からVARIANTを初期化する。

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

シグネチャ

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

HRESULT InitVariantFromStrRet(
    STRRET* pstrret,
    ITEMIDLIST* pidl,
    VARIANT* pvar
);

パラメーター

名前	型	方向	説明
pstrret	STRRET*	in	STRRET 構造体へのポインターです。
pidl	ITEMIDLIST*	in	詳細を取得する項目の PIDL です。
pvar	VARIANT*	out	この関数が返るとき、初期化された VARIANT 構造体が格納されます。

戻り値の型: HRESULT

公式ドキュメント

STRRET 構造体に格納された文字列で VARIANT 構造体を初期化します。

戻り値

型: HRESULT

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

解説(Remarks)

VT_BSTR バリアントを作成します。

注意この関数は、STRRET の内容に使用されているリソースを解放します。

例

次の例は、より大きなプログラムの一部として組み込むことを想定しており、InitVariantFromStrRet の使用方法を示します。

// STRRET strret;
// PCUITEMID_CHILD pidl;
// Assume variables strret and pidl are initialized and valid.
VARIANT var;

HRESULT hr = InitVariantFromStrRet(strret, pidl, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_BSTR.
    VariantClear(&var);
}

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

各言語での呼び出し定義

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

HRESULT InitVariantFromStrRet(
    STRRET* pstrret,
    ITEMIDLIST* pidl,
    VARIANT* pvar
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int InitVariantFromStrRet(
    IntPtr pstrret,   // STRRET*
    IntPtr pidl,   // ITEMIDLIST*
    IntPtr pvar   // VARIANT* out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function InitVariantFromStrRet(
    pstrret As IntPtr,   ' STRRET*
    pidl As IntPtr,   ' ITEMIDLIST*
    pvar As IntPtr   ' VARIANT* out
) As Integer
End Function

' pstrret : STRRET*
' pidl : ITEMIDLIST*
' pvar : VARIANT* out
Declare PtrSafe Function InitVariantFromStrRet Lib "propsys" ( _
    ByVal pstrret As LongPtr, _
    ByVal pidl As LongPtr, _
    ByVal pvar As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InitVariantFromStrRet = ctypes.windll.propsys.InitVariantFromStrRet
InitVariantFromStrRet.restype = ctypes.c_int
InitVariantFromStrRet.argtypes = [
    ctypes.c_void_p,  # pstrret : STRRET*
    ctypes.c_void_p,  # pidl : ITEMIDLIST*
    ctypes.c_void_p,  # pvar : VARIANT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
InitVariantFromStrRet = Fiddle::Function.new(
  lib['InitVariantFromStrRet'],
  [
    Fiddle::TYPE_VOIDP,  # pstrret : STRRET*
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST*
    Fiddle::TYPE_VOIDP,  # pvar : VARIANT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "propsys")]
extern "system" {
    fn InitVariantFromStrRet(
        pstrret: *mut STRRET,  // STRRET*
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST*
        pvar: *mut VARIANT  // VARIANT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PROPSYS.dll")]
public static extern int InitVariantFromStrRet(IntPtr pstrret, IntPtr pidl, IntPtr pvar);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PROPSYS_InitVariantFromStrRet' -Namespace Win32 -PassThru
# $api::InitVariantFromStrRet(pstrret, pidl, pvar)

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

出力引数:

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