Função StringCchGetsA (strsafe.h)

  • Artigo

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 além do final desse buffer.

Nota Essa função só pode ser usada embutida.
 
StringCchGets é uma substituição para as seguintes funções: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 StringCchGetsA(
  [out] STRSAFE_LPSTR 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 tenha êxito. O número máximo de caracteres permitidos, incluindo o caractere nulo de terminação, é STRSAFE_MAX_CCH. Se cchDest for muito pequeno para manter a linha completa do texto, os dados serão truncados.

Valor retornado

Tipo: HRESULT

Essa função pode retornar um dos valores a seguir. É altamente recomendável que você use as macros SUCCEEDED e FAILED 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 pszDest e o buffer foi encerrado em nulo.
STRSAFE_E_END_OF_FILE
 Indica um erro ou uma condição de fim do 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 , ao contrário das funções que ela substitui.

Comentários

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 estouros de buffer. StringCchGets sempre termina em nulo um buffer de destino diferente de zero.

O valor de pszDest não deve ser NULL. Consulte StringCchGetsEx se você precisar da manipulação de valores de ponteiro de cadeia de caracteres nula.

StringCchGets pode ser usado 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 da cadeia de caracteres Literal da cadeia de caracteres Função
char “cadeia de caracteres” StringCchGetsA
TCHAR TEXT("string") StringCchGets
WCHAR L"string" StringCchGetsW
 

Observação

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 de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

   
Cliente mínimo com suporte Windows XP com SP2 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2003 com SP1 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho strsafe.h

Confira também

Referência

StringCbGets

StringCchGetsEx