StrRetToStrA

関数

STRRET構造体を割り当て済み文字列に変換する。

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

シグネチャ

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

HRESULT StrRetToStrA(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPSTR* ppsz
);

パラメーター

名前	型	方向	説明
pstr	STRRET*	inout	STRRET 構造体へのポインターです。関数が戻ると、このポインターは無効になります。
pidl	ITEMIDLIST*	inoptional	項目の ITEMIDLIST 構造体へのポインターです。この値は NULL でもかまいません。
ppsz	LPSTR*	out	結果を格納した割り当て済み文字列へのポインターです。StrRetToStr は、この文字列のメモリを CoTaskMemAlloc で割り当てます。不要になったら、CoTaskMemFree でこの文字列を解放してください。

戻り値の型: HRESULT

公式ドキュメント

IShellFolder::GetDisplayNameOf が返す STRRET 構造体を受け取り、表示名を格納した割り当て済み文字列へのポインターを返します。(ANSI)

戻り値

型: HRESULT

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 StrRetToStrA(
    STRRET* pstr,
    ITEMIDLIST* pidl,   // optional
    LPSTR* ppsz
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int StrRetToStrA(
    IntPtr pstr,   // STRRET* in/out
    IntPtr pidl,   // ITEMIDLIST* optional
    IntPtr ppsz   // LPSTR* out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrRetToStrA(
    pstr As IntPtr,   ' STRRET* in/out
    pidl As IntPtr,   ' ITEMIDLIST* optional
    ppsz As IntPtr   ' LPSTR* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

StrRetToStrA = ctypes.windll.shlwapi.StrRetToStrA
StrRetToStrA.restype = ctypes.c_int
StrRetToStrA.argtypes = [
    ctypes.c_void_p,  # pstr : STRRET* in/out
    ctypes.c_void_p,  # pidl : ITEMIDLIST* optional
    ctypes.c_void_p,  # ppsz : LPSTR* out
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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