Função StringCbGetsA (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.
 
StringCbGets é uma substituição para as seguintes funções:StringCbGets não é uma substituição para fgets, que não substitui caracteres de nova linha por um caractere nulo de terminação.

Sintaxe

STRSAFEAPI StringCbGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cbDest
);

Parâmetros

[out] pszDest

Tipo: LPTSTR

O buffer de destino, que recebe a entrada.

[in] cbDest

Tipo: size_t

O tamanho do buffer de destino, em bytes. Esse valor deve ser maior do que sizeof(TCHAR) para que a função tenha êxito. O número máximo de bytes permitidos é STRSAFE_MAX_CCH * sizeof(TCHAR). Se cbDest 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 dados 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 cbDest é maior que o valor máximo permitido.
STRSAFE_E_INSUFFICIENT_BUFFER
 O valor em cbDest é sizeof(TCHAR) ou menos.
 

Observe que essa função retorna um valor HRESULT , ao contrário das funções que ela substitui.

Comentários

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

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

StringCbGets 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” StringCbGetsA
TCHAR TEXT("string") StringCbGets
WCHAR L"string" StringCbGetsW
 

Observação

O cabeçalho strsafe.h define StringCbGets 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

StringCbGetsEx

StringCchGets