GetSaveFileNameA 関数 (commdlg.h)

[アーティクル]
08/22/2023

[Windows Vista 以降、 共通のダイアログ ボックスと [名前を付けて保存 ] ダイアログボックスは、[ 共通項目] ダイアログボックスに置き換えられます。 [共通ダイアログボックスライブラリ] のダイアログボックスではなく、共通項目ダイアログ API を使用することをお勧めします。

ユーザーが保存するファイルのドライブ、ディレクトリ、名前を指定できる [保存] ダイアログボックスを作成します。

構文

BOOL GetSaveFileNameA(
  [in, out] LPOPENFILENAMEA unnamedParam1
);

パラメーター

[in, out] unnamedParam1

種類: LPOPENFILENAME

ダイアログボックスの初期化に使用される情報を含む OPENFILENAME 構造体へのポインター。 GetSaveFileName が返されると、この構造体にはユーザーのファイル選択に関する情報が含まれます。

戻り値

種類: BOOL

ユーザーがファイル名を指定し、[ OK] ボタンをクリックし、関数が成功した場合、戻り値は 0 以外になります。 OPENFILENAME 構造体の lpstrFile メンバーが指すバッファーには、ユーザーが指定した完全なパスとファイル名が含まれています。

ユーザーが [ 保存 ] ダイアログボックスをキャンセルまたは閉じた場合、またはファイル名バッファーが小さすぎるなどのエラーが発生した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 CommDlgExtendedError 関数を呼び出します。この関数は、次のいずれかの値を返すことができます。

注釈

Windows エクスプローラーに似たユーザーインターフェイス機能を提供するエクスプローラースタイルの [保存] ダイアログボックス。エクスプローラースタイルの [保存] ダイアログボックスに OFNHookProc フックプロシージャを指定できます。フックプロシージャを有効にするには、OPENFILENAME 構造体の Flags メンバーにOFN_EXPLORERフラグとOFN_ENABLEHOOK フラグを設定し、lpfnHook メンバーのフックプロシージャのアドレスを指定します。

Windows では、古いスタイルのユーザーインターフェイスと一貫性のあるユーザーインターフェイスを維持するアプリケーションの古いスタイルの [保存 ] ダイアログボックスが引き続きサポートされます。古いスタイルの [保存 ] ダイアログボックスを表示するには、 OFNHookProcOldStyle フックプロシージャを有効にし、 OFN_EXPLORER フラグが設定されていないことを確認します。

例

例については、「拡張メタファイルの作成」を参照してください。

注意

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

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	commdlg.h (Windows.h を含む)
Library	Comdlg32.lib
[DLL]	Comdlg32.dll
API セット	ext-ms-win-shell-comdlg32-l1-1-1 (Windows 10 バージョン 10.0.14393 で導入)