PathCchRemoveFileSpec 関数 (pathcch.h)

パス文字列内の最後の要素を削除します。その要素がファイル名かディレクトリ名かに関係なく削除されます。 要素の先頭の円記号も削除されます。

この関数は PathRemoveFileSpec とは異なり、"\"、"\?" および "\?\UNC" プレフィックスを持つパスを受け入れます。

メモバッファー オーバーランが発生しないように、 PathRemoveFileSpec の代わりにこの関数を使用する必要があります。

構文

WINPATHCCHAPI HRESULT PathCchRemoveFileSpec(
  [in, out] PWSTR  pszPath,
  [in]      size_t cchPath
);

パラメーター

[in, out] pszPath

完全修飾パス文字列へのポインター。 この関数が正常に返されると、文字列の最後の要素とその先頭の円記号が削除されます。 この関数は、"C:" などのルート パスには影響しません。 ルート パスの場合、パス文字列は変更されていない状態で返されます。 パス文字列が末尾の円記号で終わる場合は、その円記号のみが削除されます。

[in] cchPath

pszPath が指すバッファーのサイズ (文字数)。

戻り値

この関数は、関数が成功した場合は S_OK 、削除するものがない場合は S_FALSE 、それ以外の場合はエラー コードを返します。

注釈

次の表は、パス文字列の選択に対するこの関数の効果を示しています。

元の文字列	返される文字列
"C:\path1"	"C:\"
"C:\path1\path2"	"C:\path1"
"C:\path1\"	"C:\path1"
"\\path1\path2\path3"	"\\path1\path2"
"\path1"	"\"

要件

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	pathcch.h
Library	Pathcch.lib