Função PathCchRemoveFileSpec (pathcch.h)

Remove o último elemento em uma cadeia de caracteres de caminho, se esse elemento é um nome de arquivo ou um nome de diretório. A barra invertida à esquerda do elemento também é removida.

Essa função é diferente de PathRemoveFileSpec , pois aceita caminhos com prefixos "\", "\?" e "\?\UNC".

NotaEssa função deve ser usada no lugar de PathRemoveFileSpec para evitar a possibilidade de um estouro de buffer.

Sintaxe

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

Parâmetros

[in, out] pszPath

Um ponteiro para a cadeia de caracteres de caminho totalmente qualificada. Quando essa função retornar com êxito, a cadeia de caracteres terá seu último elemento e sua barra invertida à esquerda removidas. Essa função não afeta caminhos raiz como "C:". No caso de um caminho raiz, a cadeia de caracteres de caminho é retornada sem alterações. Se uma cadeia de caracteres de caminho terminar com uma barra invertida à direita, somente essa barra invertida será removida.

[in] cchPath

O tamanho do buffer apontado por pszPath, em caracteres.

Retornar valor

Essa função retornará S_OK se a função tiver sido bem-sucedida, S_FALSE se não houver nada a ser removido ou um código de erro de outra forma.

Comentários

A tabela a seguir mostra o efeito dessa função em uma seleção de cadeias de caracteres de caminho.

Cadeia de caracteres original	Cadeia de caracteres retornada
"C:\path1"	"C:\"
"C:\path1\path2"	"C:\path1"
"C:\path1\"	"C:\path1"
"\\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