StrRetToBSTR

関数

STRRET構造体をBSTR文字列に変換する。

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

シグネチャ

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

HRESULT StrRetToBSTR(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPWSTR* pbstr
);

パラメーター

名前	型	方向	説明
pstr	STRRET*	inout	STRRET 構造体へのポインターです。この関数が返るとき、このポインターはもはや有効ではありません。
pidl	ITEMIDLIST*	inoptional	親フォルダーを基準としてファイルオブジェクトまたはサブフォルダーを一意に識別する ITEMIDLIST へのポインターです。この値は NULL でもかまいません。
pbstr	LPWSTR*	out	変換後の文字列を受け取る BSTR 型の変数へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

IShellFolder::GetDisplayNameOf が返す、文字列を保持または指し示す STRRET 構造体を受け取り、その文字列を BSTR として返します。

戻り値

型: HRESULT

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

解説(Remarks)

pstr が指す STRRET 構造体の uType メンバーが STRRET_WSTR に設定されている場合、その構造体の pOleStr メンバーは関数が返るときに解放されます。

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

各言語での呼び出し定義

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

HRESULT StrRetToBSTR(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPWSTR* pbstr
);

[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int StrRetToBSTR(
    IntPtr pstr,   // STRRET* in/out
    IntPtr pidl,   // ITEMIDLIST* optional
    IntPtr pbstr   // LPWSTR* out
);

<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function StrRetToBSTR(
    pstr As IntPtr,   ' STRRET* in/out
    pidl As IntPtr,   ' ITEMIDLIST* optional
    pbstr As IntPtr   ' LPWSTR* out
) As Integer
End Function

' pstr : STRRET* in/out
' pidl : ITEMIDLIST* optional
' pbstr : LPWSTR* out
Declare PtrSafe Function StrRetToBSTR Lib "shlwapi" ( _
    ByVal pstr As LongPtr, _
    ByVal pidl As LongPtr, _
    ByVal pbstr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StrRetToBSTR = ctypes.windll.shlwapi.StrRetToBSTR
StrRetToBSTR.restype = ctypes.c_int
StrRetToBSTR.argtypes = [
    ctypes.c_void_p,  # pstr : STRRET* in/out
    ctypes.c_void_p,  # pidl : ITEMIDLIST* optional
    ctypes.c_void_p,  # pbstr : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrRetToBSTR = Fiddle::Function.new(
  lib['StrRetToBSTR'],
  [
    Fiddle::TYPE_VOIDP,  # pstr : STRRET* in/out
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST* optional
    Fiddle::TYPE_VOIDP,  # pbstr : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn StrRetToBSTR(
        pstr: *mut STRRET,  // STRRET* in/out
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST* optional
        pbstr: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int StrRetToBSTR(IntPtr pstr, IntPtr pidl, IntPtr pbstr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrRetToBSTR' -Namespace Win32 -PassThru
# $api::StrRetToBSTR(pstr, pidl, pbstr)

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

出力引数:

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