SHGetSpecialFolderPathA 関数 (shlobj_core.h)

  • [アーティクル]

[SHGetSpecialFolderPath はサポートされていません。 代わりに、 SHGetFolderPath を使用します。

CSIDL によって識別される特殊なフォルダーのパスを取得します。

構文

BOOL SHGetSpecialFolderPathA(
        HWND  hwnd,
  [out] LPSTR pszPath,
  [in]  int   csidl,
  [in]  BOOL  fCreate
);

パラメーター

hwnd

型: HWND

予約済み。

[out] pszPath

種類: LPTSTR

指定したフォルダーのドライブとパスを受け取る null で終わる文字列へのポインター。 このバッファーのサイズは、少なくともMAX_PATH文字である必要があります。

[in] csidl

型: int

目的のフォルダーを識別する CSIDL 。 仮想フォルダーを指定すると、この関数は失敗します。

[in] fCreate

種類: BOOL

フォルダーがまだ存在しない場合に作成する必要があるかどうかを示します。 この値が 0 以外の場合は、フォルダーが作成されます。 この値が 0 の場合、フォルダーは作成されません。

戻り値

種類: BOOL

成功した場合は TRUE。それ以外の場合は FALSE。

注釈

この機能を使用できるようにするには、Microsoft Internet エクスプローラー 4.0 Desktop Update をインストールする必要があります。

注意

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

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shlobj_core.h (Shlobj.h、Shlobj_core.h を含む)
Library Shell32.lib
[DLL] Shell32.dll (バージョン 4.71 以降)