Função StringCbGetsExA (strsafe.h)
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.
stringCbGetsEx é uma substituição para as seguintes funções:
StringCbGetsEx não é um substituto para fgets, que não substitui caracteres de nova linha por um caractere nulo de terminação.Sintaxe
STRSAFEAPI StringCbGetsExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Parâmetros
[out] pszDest
Tipo: LPTSTR
O buffer de destino, que deve receber a entrada.
[in] cbDest
Tipo: size_t
O tamanho do buffer de destino, em bytes. Esse valor deve ser maior 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 de texto, os dados serão truncados.
[out, optional] ppszDestEnd
Tipo: LPTSTR*
O endereço de um ponteiro até o final de pszDest. Se ppszDestEnd não for NULL e todos os dados forem copiados para o buffer de destino, isso apontará para o caractere nulo de encerramento no final da cadeia de caracteres.
[out, optional] pcbRemaining
Tipo: size_t*
O número de bytes não utilizados em pszDest, incluindo aqueles usados para o caractere nulo de terminação. Se pcbRemaining for NULL, a contagem não será mantida ou retornada.
[in] dwFlags
Tipo: DWORD
Um ou mais dos valores a seguir.
Valor | Significado |
---|---|
|
Se a função for bem-sucedida, o byte baixo de dwFlags (0) será usado para preencher a parte não inicializada de pszDest após o término do caractere nulo. |
|
Trate ponteiros de cadeia de caracteres NULL como cadeias de caracteres vazias (TEXT(")). Esse sinalizador é útil para emular funções como lstrcpy. |
|
Se a função falhar, o byte baixo de dwFlags (0) será usado para preencher todo o buffer de pszDest e o buffer será encerrado em nulo. No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres truncada retornada é substituída. |
|
Se a função falhar, pszDest será definido como uma cadeia de caracteres vazia (TEXT(")). No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres truncada é substituída. |
|
Como no caso de STRSAFE_NULL_ON_FAILURE, se a função falhar, pszDest é definido como uma cadeia de caracteres vazia (TEXT("")). No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres truncada é substituída. |
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 |
---|---|
|
Os dados foram lidos do stdin, foram copiados para o buffer em pszDeste o buffer foi encerrado em nulo. |
|
Indica um erro ou uma condição de fim de arquivo. Use feof ou ferror para determinar qual ocorreu. |
|
O valor em cbDest é maior que o valor máximo permitido ou um sinalizador inválido foi passado. |
|
O valor em cbDest é 1 ou menos. |
Observe que essa função retorna um valor HRESULT, diferentemente das funções que ela substitui.
Observações
StringCbGetsEx 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. StringCbGetsEx sempre encerra nulo um buffer de destino de comprimento diferente de zero.
O valor de pszDest não deve ser NULL, a menos que o sinalizador STRSAFE_IGNORE_NULLS seja especificado. No entanto, um erro devido ao espaço insuficiente ainda pode ser retornado, embora valores de NULL sejam ignorados.
stringCbGetsEx 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 de cadeia de caracteres | Literal de cadeia de caracteres | Função |
---|---|---|
char | "string" | StringCbGetsExA |
TCHAR | TEXT("string") | |
WCHAR | L"string" | |
Nota
O cabeçalho strsafe.h define StringCbGetsEx 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