Função PathCchAddBackslashEx (pathcch.h)

Artigo
03/05/2024

Adiciona uma barra invertida ao final de uma cadeia de caracteres para criar a sintaxe correta para um caminho. Se o caminho de origem já tiver uma barra invertida à direita, nenhuma barra invertida será adicionada.

Essa função difere de PathCchAddBackslash , pois pode retornar um ponteiro para a nova extremidade da cadeia de caracteres e relatar o número de caracteres não utilizados restantes no buffer.

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

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

Sintaxe

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

Parâmetros

[in, out] pszPath

Um ponteiro para a cadeia de caracteres do caminho. Quando essa função retorna com êxito, o buffer contém a cadeia de caracteres com a barra invertida acrescentada. Esse valor não deve ser NULL.

[in] cchPath

O tamanho do buffer apontado por pszPath, em caracteres.

[out, optional] ppszEnd

Um valor que, quando essa função retorna com êxito, recebe o endereço de um ponteiro para o caractere nulo de terminação no final da cadeia de caracteres.

[out, optional] pcchRemaining

Um ponteiro para um valor que, quando essa função retorna com êxito, é definido como o número de caracteres não utilizados no buffer de destino, incluindo o caractere nulo de terminação.

Retornar valor

Essa função retornará S_OK se a função tiver sido bem-sucedida, S_FALSE se a cadeia de caracteres de caminho já terminar em uma barra invertida ou um código de erro caso contrário.

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

Confira também

PathCchAddBackslash

Compartilhar via