ホーム › UI.Shell › InitPropVariantFromStrRet

InitPropVariantFromStrRet

関数

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

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

シグネチャ

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

HRESULT InitPropVariantFromStrRet(
    STRRET* pstrret,
    ITEMIDLIST* pidl,   // optional
    PROPVARIANT* ppropvar
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

解説(Remarks)

VT_LPWSTR の propvariant を作成します。

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

例

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

// STRRET strret;
// PCUITEMID_CHILD pidl;
// 変数 strret と pidl は初期化済みで有効であると仮定します。
PROPVARIANT propvar;

HRESULT hr = InitPropVariantFromStrRet(strret, pidl, &propvar);

if (SUCCEEDED(hr))
{
    // propvar は有効となり、型は VT_LPWSTR です。
    PropVariantClear(&propvar);
    
    // strret に関連付けられて割り当てられていたメモリはすべて解放されています。
}

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

各言語での呼び出し定義

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

HRESULT InitPropVariantFromStrRet(
    STRRET* pstrret,
    ITEMIDLIST* pidl,   // optional
    PROPVARIANT* ppropvar
);

[DllImport("PROPSYS.dll", ExactSpelling = true)]
static extern int InitPropVariantFromStrRet(
    IntPtr pstrret,   // STRRET* in/out
    IntPtr pidl,   // ITEMIDLIST* optional
    IntPtr ppropvar   // PROPVARIANT* out
);

<DllImport("PROPSYS.dll", ExactSpelling:=True)>
Public Shared Function InitPropVariantFromStrRet(
    pstrret As IntPtr,   ' STRRET* in/out
    pidl As IntPtr,   ' ITEMIDLIST* optional
    ppropvar As IntPtr   ' PROPVARIANT* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

InitPropVariantFromStrRet = ctypes.windll.propsys.InitPropVariantFromStrRet
InitPropVariantFromStrRet.restype = ctypes.c_int
InitPropVariantFromStrRet.argtypes = [
    ctypes.c_void_p,  # pstrret : STRRET* in/out
    ctypes.c_void_p,  # pidl : ITEMIDLIST* optional
    ctypes.c_void_p,  # ppropvar : PROPVARIANT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PROPSYS.dll')
InitPropVariantFromStrRet = Fiddle::Function.new(
  lib['InitPropVariantFromStrRet'],
  [
    Fiddle::TYPE_VOIDP,  # pstrret : STRRET* in/out
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST* optional
    Fiddle::TYPE_VOIDP,  # ppropvar : PROPVARIANT* out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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