GetFileTitleW

指定されたファイルの名前を取得する。(Unicode)

GetFileTitleW param0, Buf, cchSize

param0 : [wstr] 
Buf : [wstr] 型: LPTSTR ファイル名を受け取るバッファ。
cchSize : [int] 型: WORD lpszTitle パラメータが指すバッファの長さ(文字数)。

(プラグイン / モジュール : comdlg32.dll)

解説

指定されたファイルの名前を取得する。(Unicode)

[戻り値]
型: short 関数が成功した場合、戻り値は 0
である。ファイル名が無効な場合、戻り値は不定である。エラーが発生した場合、戻り値は負の数となる。lpszTitle
パラメータが指すバッファが小さすぎる場合、戻り値は必要なバッファサイズ(文字数)を表す正の整数となる。必要なバッファサイズには終端の
null 文字も含まれる。

[備考]
GetFileTitle
は正当なファイル名でのみ呼び出すべきである。不正なファイル名を使用した場合の結果は未定義である。ファイル名を格納するために必要なバッファサイズを取得するには、lpszTitle
に NULL、cchSize に 0 を指定して関数を呼び出す。関数は必要なサイズを返す。GetFileTitle
はシステムがファイル名をユーザーに表示する際に使用する文字列を返す。表示名は、ユーザーがファイル名表示の設定で拡張子表示を有効にしている場合にのみ拡張子を含む。そのため、返される文字列はファイルシステム関数の呼び出しに使用する場合、ファイルを正確に識別できないことがある。lpszTitle
バッファが小さすぎる場合、GetFileTitle は表示名を保持するために必要なサイズを返す。ただし、必要サイズと lpszFile
バッファに元々指定された文字との間に保証された関係はない。例えば、lpszTitle に NULL、cchSize に 0 を指定して
GetFileTitle を呼び出し、その戻り値を lpszFile
文字列のインデックスとして使用してはならない。同様の結果(およびより優れた性能)は、strrchr、wcsrchr、_mbsrchr
などの C ランタイムライブラリ関数で達成できることが多い。
> [!NOTE] > commdlg.h ヘッダは GetFileTitle を、UNICODE
プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode
版を自動的に選択するエイリアスとして定義している。エンコーディング中立なエイリアスとエンコーディング中立でないコードを混在させると、コンパイルや実行時のエラーにつながる不一致が発生する場合がある。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報

プラグイン / モジュールcomdlg32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の comdlg32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_comdlg32_gen2.hs