次の方法で共有


GetFileTitleA 関数 (commdlg.h)

指定したファイルの名前を取得します。

構文

short GetFileTitleA(
  [in]  LPCSTR unnamedParam1,
  [out] LPSTR  Buf,
  [in]  WORD   cchSize
);

パラメーター

[in] unnamedParam1

型: LPCTSTR

ファイルの名前と場所。

[out] Buf

型: LPTSTR

ファイルの名前を受け取るバッファー。

[in] cchSize

型: word

lpszTitle パラメーターが指すバッファーの長さ (文字数)。

戻り値

型: 短い

関数が成功した場合、戻り値は 0 です。

ファイル名が無効な場合、戻り値は不明です。 エラーが発生した場合、戻り値は負の数になります。

lpszTitle パラメーターが指すバッファーが小さすぎる場合、戻り値は、必要なバッファー サイズを文字で指定する正の整数です。 必要なバッファー サイズには、終端の null 文字が含まれます。

備考

GetFileTitle は、有効なファイル名でのみ呼び出す必要があります。無効なファイル名を使用すると、未定義の結果になります。

ファイルの名前に必要なバッファー サイズを取得するには、lpszTitle null を に設定し、cchSize を 0 に設定 関数を呼び出します。 この関数は、必要なサイズを返します。

GetFileTitle は、システムがユーザーにファイル名を表示するために使用する文字列を返します。 表示名に拡張子が含まれるのは、ユーザーがファイル名を表示する場合のみです。 つまり、返される文字列は、ファイル システム関数の呼び出しで使用されている場合、ファイルを正確に識別できない可能性があります。

lpszTitle バッファーが小さすぎる場合、GetFileTitle は表示名を保持するために必要なサイズを返します。 ただし、必要なサイズと、lpszFile バッファーで最初に指定された文字との間には、保証された関係はありません。 たとえば、lpszTitle を null に 設定 getFileTitle を呼び出したり、cchSize を 0 に設定 したり、戻り値を lpszFile 文字列のインデックスとして使用したりしないでください。 通常、strrchrwcsrchr_mbsrchrなどの C ランタイム ライブラリ関数を使用して、同様の結果 (および優れたパフォーマンス) を実現できます。

手記

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

必要条件

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

関連項目

共通ダイアログ ボックス ライブラリ

概念

GetOpenFileName の

GetSaveFileName を する

リファレンス