PathCchStripToRoot 関数 (pathcch.h)
ルート情報を除き、パス内のすべてのファイル要素とディレクトリ要素を削除します。
この関数は PathStripToRoot とは異なり、"\"、"\?" および "\?\UNC" プレフィックスを持つパスを受け入れます。
メモ この関数は、バッファー オーバーランの可能性を防ぐために PathStripToRoot の代わりに使用する必要があります。
構文
WINPATHCCHAPI HRESULT PathCchStripToRoot(
[in, out] PWSTR pszPath,
[in] size_t cchPath
);
パラメーター
[in, out] pszPath
パス文字列へのポインター。 この関数が正常に返されると、この文字列には、そのパスから取得されたルート情報のみが含まれます。
[in] cchPath
pszPath が指すバッファーのサイズ (文字数)。
戻り値
この関数は、パスが切り捨てられた場合は S_OK を返 します。パス が既にルートであった場合は S_FALSE、 HRESULT エラー コードは返されます。
注釈
この関数の効果の例を次に示します。
初期文字列 | 最後の文字列 |
---|---|
"C:\path1\path2\file" | "C:\" |
"\\path1\path2\path3" | "\\path1\path2" |
"\path1" | "\" |
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 8 [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2012 [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | pathcch.h |
Library | Pathcch.lib |