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 ヘッダーは、STRRetToStr をエイリアスとして定義します。このエイリアスは、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 以降)

こちらもご覧ください

StrRetToBuf