Win32 API 日本語リファレンス
ホームUI.Shell › StrRetToBufW

StrRetToBufW

関数
STRRET構造体の内容をバッファに展開する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

HRESULT StrRetToBufW(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPWSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前方向説明
pstrSTRRET*inoutSTRRET 構造体へのポインターです。関数が戻ると、このポインターは無効になります。
pidlITEMIDLIST*inoptional項目の ITEMIDLIST 構造体へのポインターです。
pszBufLPWSTRout表示名を格納するバッファです。null で終わる文字列として返されます。cchBuf が小さすぎる場合、名前は収まるように切り詰められます。
cchBufDWORDinpszBuf のサイズを文字数で指定します。cchBuf が小さすぎる場合、文字列は収まるように切り詰められます。

戻り値の型: HRESULT

公式ドキュメント

IShellFolder::GetDisplayNameOf が返す STRRET 構造体を文字列に変換し、その結果をバッファに格納します。(Unicode)

戻り値

型: HRESULT

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

解説(Remarks)

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

メモ

shlwapi.h ヘッダーは StrRetToBuf をエイリアスとして定義しており、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

HRESULT StrRetToBufW(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPWSTR pszBuf,
    DWORD cchBuf
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int StrRetToBufW(
    IntPtr pstr,   // STRRET* in/out
    IntPtr pidl,   // ITEMIDLIST* optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuf,   // LPWSTR out
    uint cchBuf   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrRetToBufW(
    pstr As IntPtr,   ' STRRET* in/out
    pidl As IntPtr,   ' ITEMIDLIST* optional
    <MarshalAs(UnmanagedType.LPWStr)> pszBuf As System.Text.StringBuilder,   ' LPWSTR out
    cchBuf As UInteger   ' DWORD
) As Integer
End Function
' pstr : STRRET* in/out
' pidl : ITEMIDLIST* optional
' pszBuf : LPWSTR out
' cchBuf : DWORD
Declare PtrSafe Function StrRetToBufW Lib "shlwapi" ( _
    ByVal pstr As LongPtr, _
    ByVal pidl As LongPtr, _
    ByVal pszBuf As LongPtr, _
    ByVal cchBuf As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StrRetToBufW = ctypes.windll.shlwapi.StrRetToBufW
StrRetToBufW.restype = ctypes.c_int
StrRetToBufW.argtypes = [
    ctypes.c_void_p,  # pstr : STRRET* in/out
    ctypes.c_void_p,  # pidl : ITEMIDLIST* optional
    wintypes.LPWSTR,  # pszBuf : LPWSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrRetToBufW = Fiddle::Function.new(
  lib['StrRetToBufW'],
  [
    Fiddle::TYPE_VOIDP,  # pstr : STRRET* in/out
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST* optional
    Fiddle::TYPE_VOIDP,  # pszBuf : LPWSTR out
    -Fiddle::TYPE_INT,  # cchBuf : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn StrRetToBufW(
        pstr: *mut STRRET,  // STRRET* in/out
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST* optional
        pszBuf: *mut u16,  // LPWSTR out
        cchBuf: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int StrRetToBufW(IntPtr pstr, IntPtr pidl, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrRetToBufW' -Namespace Win32 -PassThru
# $api::StrRetToBufW(pstr, pidl, pszBuf, cchBuf)
#uselib "SHLWAPI.dll"
#func global StrRetToBufW "StrRetToBufW" wptr, wptr, wptr, wptr
; StrRetToBufW varptr(pstr), varptr(pidl), varptr(pszBuf), cchBuf   ; 戻り値は stat
; pstr : STRRET* in/out -> "wptr"
; pidl : ITEMIDLIST* optional -> "wptr"
; pszBuf : LPWSTR out -> "wptr"
; cchBuf : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global StrRetToBufW "StrRetToBufW" var, var, var, int
; res = StrRetToBufW(pstr, pidl, pszBuf, cchBuf)
; pstr : STRRET* in/out -> "var"
; pidl : ITEMIDLIST* optional -> "var"
; pszBuf : LPWSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT StrRetToBufW(STRRET* pstr, ITEMIDLIST* pidl, LPWSTR pszBuf, DWORD cchBuf)
#uselib "SHLWAPI.dll"
#cfunc global StrRetToBufW "StrRetToBufW" var, var, var, int
; res = StrRetToBufW(pstr, pidl, pszBuf, cchBuf)
; pstr : STRRET* in/out -> "var"
; pidl : ITEMIDLIST* optional -> "var"
; pszBuf : LPWSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrRetToBufW = shlwapi.NewProc("StrRetToBufW")
)

// pstr (STRRET* in/out), pidl (ITEMIDLIST* optional), pszBuf (LPWSTR out), cchBuf (DWORD)
r1, _, err := procStrRetToBufW.Call(
	uintptr(pstr),
	uintptr(pidl),
	uintptr(pszBuf),
	uintptr(cchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function StrRetToBufW(
  pstr: Pointer;   // STRRET* in/out
  pidl: Pointer;   // ITEMIDLIST* optional
  pszBuf: PWideChar;   // LPWSTR out
  cchBuf: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrRetToBufW';
result := DllCall("SHLWAPI\StrRetToBufW"
    , "Ptr", pstr   ; STRRET* in/out
    , "Ptr", pidl   ; ITEMIDLIST* optional
    , "Ptr", pszBuf   ; LPWSTR out
    , "UInt", cchBuf   ; DWORD
    , "Int")   ; return: HRESULT
●StrRetToBufW(pstr, pidl, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "int StrRetToBufW(void*, void*, char*, dword)")
# 呼び出し: StrRetToBufW(pstr, pidl, pszBuf, cchBuf)
# pstr : STRRET* in/out -> "void*"
# pidl : ITEMIDLIST* optional -> "void*"
# pszBuf : LPWSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn StrRetToBufW(
    pstr: [*c]STRRET, // STRRET* in/out
    pidl: [*c]ITEMIDLIST, // ITEMIDLIST* optional
    pszBuf: [*c]u16, // LPWSTR out
    cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc StrRetToBufW(
    pstr: ptr STRRET,  # STRRET* in/out
    pidl: ptr ITEMIDLIST,  # ITEMIDLIST* optional
    pszBuf: ptr uint16,  # LPWSTR out
    cchBuf: uint32  # DWORD
): int32 {.importc: "StrRetToBufW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int StrRetToBufW(
    STRRET* pstr,   // STRRET* in/out
    ITEMIDLIST* pidl,   // ITEMIDLIST* optional
    wchar* pszBuf,   // LPWSTR out
    uint cchBuf   // DWORD
);
ccall((:StrRetToBufW, "SHLWAPI.dll"), stdcall, Int32,
      (Ptr{STRRET}, Ptr{ITEMIDLIST}, Ptr{UInt16}, UInt32),
      pstr, pidl, pszBuf, cchBuf)
# pstr : STRRET* in/out -> Ptr{STRRET}
# pidl : ITEMIDLIST* optional -> Ptr{ITEMIDLIST}
# pszBuf : LPWSTR out -> Ptr{UInt16}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t StrRetToBufW(
    void* pstr,
    void* pidl,
    uint16_t* pszBuf,
    uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrRetToBufW(pstr, pidl, pszBuf, cchBuf)
-- pstr : STRRET* in/out
-- pidl : ITEMIDLIST* optional
-- pszBuf : LPWSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrRetToBufW = lib.func('__stdcall', 'StrRetToBufW', 'int32_t', ['void *', 'void *', 'uint16_t *', 'uint32_t']);
// StrRetToBufW(pstr, pidl, pszBuf, cchBuf)
// pstr : STRRET* in/out -> 'void *'
// pidl : ITEMIDLIST* optional -> 'void *'
// pszBuf : LPWSTR out -> 'uint16_t *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  StrRetToBufW: { parameters: ["pointer", "pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.StrRetToBufW(pstr, pidl, pszBuf, cchBuf)
// pstr : STRRET* in/out -> "pointer"
// pidl : ITEMIDLIST* optional -> "pointer"
// pszBuf : LPWSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t StrRetToBufW(
    void* pstr,
    void* pidl,
    uint16_t* pszBuf,
    uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->StrRetToBufW(pstr, pidl, pszBuf, cchBuf);
// pstr : STRRET* in/out
// pidl : ITEMIDLIST* optional
// pszBuf : LPWSTR out
// cchBuf : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    int StrRetToBufW(
        Pointer pstr,   // STRRET* in/out
        Pointer pidl,   // ITEMIDLIST* optional
        char[] pszBuf,   // LPWSTR out
        int cchBuf   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun StrRetToBufW = StrRetToBufW(
    pstr : STRRET*,   # STRRET* in/out
    pidl : ITEMIDLIST*,   # ITEMIDLIST* optional
    pszBuf : UInt16*,   # LPWSTR out
    cchBuf : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StrRetToBufWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Uint32);
typedef StrRetToBufWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, int);
final StrRetToBufW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<StrRetToBufWNative, StrRetToBufWDart>('StrRetToBufW');
// pstr : STRRET* in/out -> Pointer<Void>
// pidl : ITEMIDLIST* optional -> Pointer<Void>
// pszBuf : LPWSTR out -> Pointer<Utf16>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StrRetToBufW(
  pstr: Pointer;   // STRRET* in/out
  pidl: Pointer;   // ITEMIDLIST* optional
  pszBuf: PWideChar;   // LPWSTR out
  cchBuf: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrRetToBufW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StrRetToBufW"
  c_StrRetToBufW :: Ptr () -> Ptr () -> CWString -> Word32 -> IO Int32
-- pstr : STRRET* in/out -> Ptr ()
-- pidl : ITEMIDLIST* optional -> Ptr ()
-- pszBuf : LPWSTR out -> CWString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let strrettobufw =
  foreign "StrRetToBufW"
    ((ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pstr : STRRET* in/out -> (ptr void) *)
(* pidl : ITEMIDLIST* optional -> (ptr void) *)
(* pszBuf : LPWSTR out -> (ptr uint16_t) *)
(* cchBuf : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("StrRetToBufW" str-ret-to-buf-w :convention :stdcall) :int32
  (pstr :pointer)   ; STRRET* in/out
  (pidl :pointer)   ; ITEMIDLIST* optional
  (psz-buf :pointer)   ; LPWSTR out
  (cch-buf :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StrRetToBufW = Win32::API::More->new('SHLWAPI',
    'int StrRetToBufW(LPVOID pstr, LPVOID pidl, LPWSTR pszBuf, DWORD cchBuf)');
# my $ret = $StrRetToBufW->Call($pstr, $pidl, $pszBuf, $cchBuf);
# pstr : STRRET* in/out -> LPVOID
# pidl : ITEMIDLIST* optional -> LPVOID
# pszBuf : LPWSTR out -> LPWSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型