StrRetToStrA 関数 (shlwapi.h)
IShellFolder::GetDisplayNameOf によって返される STRRET 構造体を受け取り、表示名を含む割り当てられた文字列へのポインターを返します。
構文
LWSTDAPI StrRetToStrA(
[in, out] STRRET *pstr,
[in, optional] PCUITEMID_CHILD pidl,
[out] LPSTR *ppsz
);
パラメーター
[in, out] pstr
型: STRRET
STRRET 構造体へのポインター。 関数が戻ると、このポインターは無効になります。
[in, optional] pidl
型: PCUITEMID_CHILD
項目の ITEMIDLIST 構造体へのポインター。 この値は NULL
[out] ppsz
型: LPTSTR*
結果を含む割り当てられた文字列へのポインター。 StrRetToStr は、CoTaskMemAllocを使用して、この文字列のメモリを割り当てます。 不要になったら、CoTaskMemFree を使用して文字列を解放する必要があります。
戻り値
型: HRESULT
この関数が成功すると、S_OKが返されます。 それ以外の場合は、HRESULT エラー コードが返されます。
備考
手記
shlwapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StrRetToStr を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 2000 Professional、Windows XP [デスクトップ アプリのみ] |
サポートされる最小サーバー | Windows 2000 Server [デスクトップ アプリのみ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | shlwapi.h |
ライブラリ | Shlwapi.lib |
DLL | Shlwapi.dll (バージョン 5.0 以降) |
関連項目
StrRetToBuf の