StrRetToBufA 関数 (shlwapi.h)
IShellFolder::GetDisplayNameOf によって返される STRRET 構造体を文字列に変換し、結果をバッファーに配置します。
構文
LWSTDAPI StrRetToBufA(
[in, out] STRRET *pstr,
[in] PCUITEMID_CHILD pidl,
[out] LPSTR 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 エラー コードを返します。
注釈
pstr が指す構造体の uType メンバーがSTRRET_WSTRに設定されている場合、その構造体の pOleStr メンバーは、戻り時に解放されます。
注意
shlwapi.h ヘッダーは、StrRetToBuf をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional、Windows XP [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | shlwapi.h |
| Library | Shlwapi.lib |
| [DLL] | Shlwapi.dll (バージョン 5.0 以降) |