Função StringCchGetsW (strsafe.h)

Artigo
11/20/2024

Obtém uma linha de texto de stdin, até e incluindo o caractere newline ('\n'). A linha de texto é copiada para o buffer de destino e o caractere de nova linha é substituído por um caractere nulo. O tamanho do buffer de destino é fornecido à função para garantir que ele não escreva após o final desse buffer.

Observação Essa função só pode ser usada embutida.

StringCchGets é uma substituição para as seguintes funções:

obtém, _getws, _getts

StringCchGets não é uma substituição para fgets, que não substitui caracteres de nova linha por um caractere nulo de terminação.

Sintaxe

STRSAFEAPI StringCchGetsW(
  [out] STRSAFE_LPWSTR pszDest,
  [in]  size_t         cchDest
);

Parâmetros

[out] pszDest

Tipo: LPTSTR

O buffer de destino, que recebe os caracteres copiados.

[in] cchDest

Tipo: size_t

O tamanho do buffer de destino, em caracteres. Esse valor deve ser pelo menos 2 para que a função seja bem-sucedida. O número máximo de caracteres permitido, incluindo o caractere nulo de encerramento, é STRSAFE_MAX_CCH. Se cchDest for muito pequeno para manter a linha completa de texto, os dados serão truncados.

Valor de retorno

Tipo: HRESULT

Essa função pode retornar um dos valores a seguir. É altamente recomendável que você use o bem-sucedido e macros de COM FALHA para testar o valor retornado dessa função.

Código de retorno	Descrição
S_OK	Os caracteres foram lidos do stdin, foram copiados para o buffer em pszDeste o buffer foi encerrado em nulo.
STRSAFE_E_END_OF_FILE	Indica um erro ou uma condição de fim de arquivo. Use feof ou ferror para determinar qual ocorreu.
STRSAFE_E_INVALID_PARAMETER	O valor em cchDest é maior que o valor máximo permitido.
STRSAFE_E_INSUFFICIENT_BUFFER	O valor em cchDest é 1 ou menos.

Observe que essa função retorna um valor HRESULT, diferentemente das funções que ela substitui.

Observações

StringCchGets fornece processamento adicional para tratamento de buffer adequado em seu código. A má manipulação de buffer está implicada em muitos problemas de segurança que envolvem sobrecargas de buffer. StringCchGets sempre termina um buffer de destino diferente de zero.

O valor de pszDest não deve ser NULL. Consulte StringCchGetsEx se você precisar lidar com valores nulos de ponteiro de cadeia de caracteres.

StringCchGets podem ser usados em sua forma genérica ou em suas formas mais específicas. O tipo de dados da cadeia de caracteres determina a forma dessa função que você deve usar, conforme mostrado na tabela a seguir.

Tipo de dados de cadeia de caracteres	Literal de cadeia de caracteres	Função
char	"string"	stringCchGetsA
TCHAR	TEXT("string")	StringCchGets
WCHAR	L"string"	StringCchGetsW

Nota

O cabeçalho strsafe.h define StringCchGets como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP com SP2 [aplicativos da área de trabalho \| Aplicativos UWP]
servidor com suporte mínimo	Windows Server 2003 com SP1 [aplicativos da área de trabalho \| Aplicativos UWP]
da Plataforma de Destino	Windows
cabeçalho	strsafe.h

Consulte também

de referência de

StringCbGets

StringCchGetsEx

Compartilhar via