StrRetToBufW 関数 (shlwapi.h)

IShellFolder::GetDisplayNameOf によって返される STRRET 構造体を文字列に変換し、結果をバッファーに配置します。

構文

LWSTDAPI StrRetToBufW(
  [in, out] STRRET          *pstr,
  [in]      PCUITEMID_CHILD pidl,
  [out]     LPWSTR          pszBuf,
  [in]      UINT            cchBuf
);

パラメーター

[in, out] pstr

型: STRRET

STRRET 構造体へのポインター。 関数が戻ると、このポインターは無効になります。

[in] pidl

型: PCUITEMID_CHILD

項目の ITEMIDLIST 構造体へのポインター。

[out] pszBuf

型: LPTSTR

表示名を保持するバッファー。 これは null で終わる文字列として返されます。 cchBuf 小さすぎる場合、名前は切り捨てられ、収まります。

[in] cchBuf

型: UINT

pszBufのサイズ (文字単位)。 cchBuf 小さすぎる場合、文字列は切り捨てられ、収まります。

戻り値

型: HRESULT

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

備考

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

手記

shlwapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StrRetToBuf を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップ アプリのみ]
ターゲット プラットフォーム の	ウィンドウズ
ヘッダー	shlwapi.h
ライブラリ	Shlwapi.lib
DLL	Shlwapi.dll (バージョン 5.0 以降)

関連項目

StrRetToStr

StrRetToStrN