Função PathCchStripToRoot (pathcch.h)

Remove todos os elementos de arquivo e diretório em um caminho, exceto para as informações raiz.

Essa função difere de PathStripToRoot , pois aceita caminhos com prefixos "\", "\?" e "\?\UNC".

Nota Essa função deve ser usada no lugar de PathStripToRoot para evitar a possibilidade de um estouro de buffer.

Sintaxe

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

Parâmetros

[in, out] pszPath

Um ponteiro para a cadeia de caracteres de caminho. Quando essa função retorna com êxito, essa cadeia de caracteres contém apenas as informações raiz obtidas desse caminho.

[in] cchPath

O tamanho do buffer apontado por pszPath, em caracteres.

Retornar valor

Essa função retornará S_OK se o caminho tiver sido truncado, S_FALSE se o caminho já fosse apenas uma raiz ou um código de falha HRESULT .

Comentários

Alguns exemplos do efeito dessa função:

Cadeia de caracteres inicial	Cadeia de caracteres final
"C:\path1\path2\file"	"C:\"
"\\path1\path2\path3"	"\\path1\path2"
"\path1"	"\"

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2012 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	pathcch.h
Biblioteca	Pathcch.lib