StrRetToBufA

関数

STRRET構造体の内容をバッファに展開する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

HRESULT StrRetToBufA(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前	型	方向	説明
pstr	STRRET*	inout	STRRET 構造体へのポインターです。関数が返ると、このポインターは無効になります。
pidl	ITEMIDLIST*	inoptional	項目の ITEMIDLIST 構造体へのポインターです。
pszBuf	LPSTR	out	表示名を格納するバッファです。null 終端文字列として返されます。cchBuf が小さすぎる場合、名前は収まるように切り詰められます。
cchBuf	DWORD	in	pszBuf のサイズ(文字数)です。cchBuf が小さすぎる場合、文字列は収まるように切り詰められます。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

解説(Remarks)

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

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrRetToBuf を定義しています。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

HRESULT StrRetToBufA(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPSTR pszBuf,
    DWORD cchBuf
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int StrRetToBufA(
    IntPtr pstr,   // STRRET* in/out
    IntPtr pidl,   // ITEMIDLIST* optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf,   // LPSTR out
    uint cchBuf   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrRetToBufA(
    pstr As IntPtr,   ' STRRET* in/out
    pidl As IntPtr,   ' ITEMIDLIST* optional
    <MarshalAs(UnmanagedType.LPStr)> pszBuf As System.Text.StringBuilder,   ' LPSTR out
    cchBuf As UInteger   ' DWORD
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

StrRetToBufA = ctypes.windll.shlwapi.StrRetToBufA
StrRetToBufA.restype = ctypes.c_int
StrRetToBufA.argtypes = [
    ctypes.c_void_p,  # pstr : STRRET* in/out
    ctypes.c_void_p,  # pidl : ITEMIDLIST* optional
    wintypes.LPSTR,  # pszBuf : LPSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrRetToBufA = Fiddle::Function.new(
  lib['StrRetToBufA'],
  [
    Fiddle::TYPE_VOIDP,  # pstr : STRRET* in/out
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST* optional
    Fiddle::TYPE_VOIDP,  # pszBuf : LPSTR out
    -Fiddle::TYPE_INT,  # cchBuf : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn StrRetToBufA(
        pstr: *mut STRRET,  // STRRET* in/out
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST* optional
        pszBuf: *mut u8,  // LPSTR out
        cchBuf: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int StrRetToBufA(IntPtr pstr, IntPtr pidl, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrRetToBufA' -Namespace Win32 -PassThru
# $api::StrRetToBufA(pstr, pidl, pszBuf, cchBuf)

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

出力引数:

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