Função StringCchGetsExA (strsafe.h)

Artigo
11/20/2024

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.

Observação 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. Sinalizadores também podem ser passados para a função para controle adicional.

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

obtém, _getws, _getts

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 seja bem-sucedida. O número máximo de caracteres permitido, incluindo o caractere nulo de encerramento, é STRSAFE_MAX_CCH. Se cchDest 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] pcchRemaining

Tipo: size_t*

O número de caracteres não utilizados em 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 término do caractere nulo.
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 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.
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.

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
S_OK	Os caracteres foram lidos do stdin, foram copiados para o buffer em pszDeste o buffer foi encerrado em nulo.
STRSAFE_E_END_OF_FILE	Indica um erro ou uma condição de fim de 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, diferentemente das funções que ela substitui.

Observações

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 sobrecargas de buffer. StringCchGetsEx sempre termina 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 valores de 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 de cadeia de caracteres	Literal de cadeia de caracteres	Função
char	"string"	StringCchGetsExA
TCHAR	TEXT("string")	StringCchGetsEx
WCHAR	L"string"	stringCchGetsExW

Nota

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

StringCbGetsEx

StringCchGets

Compartilhar via