Função StringCchGetsExA (strsafe.h)

  • Artigo

Obtém uma linha de texto de stdin, até e incluindo o caractere de nova linha ('\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.

Nota Essa função só pode ser usada embutida.
 
StringCchGetsEx adiciona à funcionalidade de StringCchGets retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de caracteres deixados não utilizados nessa cadeia de caracteres. Os sinalizadores também podem ser passados para a função para controle adicional.

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

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

Sintaxe

STRSAFEAPI StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcchRemaining,
  [in]            DWORD         dwFlags
);

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.

[out, optional] ppszDestEnd

Tipo: LPTSTR*

O endereço de um ponteiro para o final do pszDest. Se ppszDestEnd não for NULL e qualquer dado for copiado para o buffer de destino, isso apontará para o caractere nulo de terminação no final da cadeia de caracteres.

[out, optional] pcchRemaining

Tipo: size_t*

O número de caracteres não utilizados no pszDest, incluindo o caractere nulo de terminação. Se pcchRemaining for NULL, a contagem não será mantida ou retornada.

[in] dwFlags

Tipo: DWORD

Um ou mais dos valores a seguir.

Valor Significado
STRSAFE_FILL_BEHIND_NULL
0x00000200
 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 caractere nulo de terminação.
STRSAFE_IGNORE_NULLS
0x00000100
 Trate ponteiros de cadeia de caracteres NULL como cadeias de caracteres vazias (TEXT("")). Esse sinalizador é útil para emular funções como lstrcpy.
STRSAFE_FILL_ON_FAILURE
0x00000400
 Se a função falhar, o byte baixo de dwFlags (0) será usado para preencher todo o buffer 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.
STRSAFE_NULL_ON_FAILURE
0x00000800
 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.
STRSAFE_NO_TRUNCATION
0x00001000
 Como no caso de STRSAFE_NULL_ON_FAILURE, 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.

Retornar valor

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 ou um sinalizador inválido foi passado.
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

StringCchGetsEx 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. StringCchGetsEx sempre termina em nulo um buffer de destino 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 os valores NULL sejam ignorados.

StringCchGetsEx 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” StringCchGetsExA
TCHAR TEXT("string") StringCchGetsEx
WCHAR L"string" StringCchGetsExW
 

Observação

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

Requisito Valor
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