PathCchRemoveBackslashEx 関数 (pathcch.h)

パス文字列の末尾から末尾の円記号を削除します。

この関数は PathCchRemoveBackslash とは異なり、文字列の新しい末尾へのポインターを返し、バッファーに残っている未使用の文字の数を報告できます。

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

構文

WINPATHCCHAPI HRESULT PathCchRemoveBackslashEx(
  [in, out]       PWSTR  pszPath,
  [in]            size_t cchPath,
  [out, optional] PWSTR  *ppszEnd,
  [out, optional] size_t *pcchRemaining
);

パラメーター

[in, out] pszPath

パス文字列へのポインター。 この関数が正常に返されると、文字列には、末尾の円記号が削除されたパスが含まれます。 末尾の円記号が見つからなかった場合、文字列は変更されません。

[in] cchPath

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

[out, optional] ppszEnd

この関数が正常に返されたときに、新しい文字列の末尾へのポインターのアドレスを受け取る値。 文字列が "C:" などのルート パスの場合、ポインターは円記号を指します。それ以外の場合、ポインターは文字列の終端の null 文字を指します。

[out, optional] pcchRemaining

この関数が正常に返されたときに、終端の null 文字を含む、宛先バッファー内の未使用の文字の数を受け取る値へのポインター。 文字列が "C:" などのルート パスの場合、このカウントにはその文字列の円記号が含まれます。

戻り値

この関数は、関数が成功した場合は S_OK を返 します。文字列 がルート パスであるか、円記号が見つからなかった場合はS_FALSE、それ以外の場合はエラー コードを返します。

注釈

この関数は、"C:" などのルート パス文字列から円記号を削除しません。

要件