_cgets_s, _cgetws_s

Obtém uma cadeia de caracteres do console. Essas versões e _cgetwstêm aprimoramentos de _cgets segurança, conforme descrito em Recursos de segurança no CRT.

Sintaxe

errno_t _cgets_s(
   char *buffer,
   size_t numberOfElements,
   size_t *pSizeRead
);
errno_t _cgetws_s(
   wchar_t *buffer
   size_t numberOfElements,
   size_t *pSizeRead
);
template <size_t size>
errno_t _cgets_s(
   char (&buffer)[size],
   size_t *pSizeRead
); // C++ only
template <size_t size>
errno_t _cgetws_s(
   wchar_t (&buffer)[size],
   size_t *pSizeRead
); // C++ only

Parâmetros

buffer
Local de armazenamento de dados.

numberOfElements
O tamanho do buffer em caracteres de byte único ou largos, que também é o número máximo de caracteres a serem lido.

pSizeRead
O número de caracteres de fato lidos.

Valor retornado

O valor retornado será zero se obtiver sucesso; caso contrário, um código de erro será gerado se ocorrer uma falha.

Condições de erro

Comentários

_cgets_s e _cgetws_s leem uma cadeia de caracteres do console e copiam a cadeia de caracteres (com um terminador nulo) para buffer. _cgetws_s é a versão de caractere largo da função; além do tamanho de caractere, o comportamento dessas duas funções é idêntico. O tamanho máximo da cadeia de caracteres a ser lido é passado como no parâmetro numberOfElements. Esse tamanho deve incluir um caractere extra para a terminação nula. O número real de caracteres lidos é colocado em pSizeRead.

Se ocorrer um erro durante a operação ou na validação dos parâmetros, o manipulador de parâmetro inválido será invocado, conforme descrito em Validação de parâmetro. Se a execução tiver permissão para continuar, errno será definido como EINVALe EINVAL será retornado.

No C++, o uso dessas funções é simplificado por sobrecargas de modelo. As sobrecargas podem inferir automaticamente o tamanho do buffer, o que elimina a necessidade de especificar um argumento de tamanho. Eles também podem substituir automaticamente funções mais antigas e menos seguras por suas contrapartes mais novas e mais seguras. Para obter mais informações, consulte Sobrecargas de modelo seguras.

As versões de biblioteca de depuração dessas funções preenchem o buffer com 0xFE. Para desabilitar esse comportamento, use _CrtSetDebugFillThreshold.

Por padrão, o estado global dessa função tem como escopo o aplicativo. Para alterar esse comportamento, confira Estado global no CRT.

Mapeamentos de rotina de texto genérico

Requisitos

Para obter informações sobre compatibilidade, consulte Compatibilidade.

Confira também

E/S de console e porta
_getch, _getwch