Compartilhar via


Função StringCchVPrintfExA (strsafe.h)

Grava dados formatados na cadeia de caracteres especificada usando um ponteiro para uma lista de argumentos. O tamanho do buffer de destino é fornecido à função para garantir que ele não escreva após o final desse buffer.

StringCchVPrintfEx adiciona à funcionalidade de StringCchVPrintf 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.

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

Sintaxe

STRSAFEAPI StringCchVPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
  [in]            va_list        argList
);

Parâmetros

[out] pszDest

Tipo: LPTSTR

O buffer de destino, que recebe a cadeia de caracteres formatada e terminada em nulo criada de pszFormat e argList.

[in] cchDest

Tipo: size_t

O tamanho do buffer de destino, em caracteres. Esse valor deve ser suficientemente grande para acomodar a cadeia de caracteres formatada final mais 1 para considerar o caractere nulo de terminação. O número máximo de caracteres permitidos é STRSAFE_MAX_CCH.

[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("")).
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.

[in] pszFormat

Tipo: LPCTSTR

A cadeia de caracteres de formato. Essa cadeia de caracteres deve ser terminada em nulo. Para obter mais informações, consulte Sintaxe de especificação de formato.

[in] argList

Tipo: va_list

Os argumentos a serem inseridos na cadeia de caracteres pszFormat .

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
Havia espaço suficiente para que o resultado fosse copiado para pszDest sem truncamento e o buffer fosse encerrado em nulo.
STRSAFE_E_INVALID_PARAMETER
O valor em cchDest é 0 ou maior que STRSAFE_MAX_CCH ou o buffer de destino já está cheio.
STRSAFE_E_INSUFFICIENT_BUFFER
A operação de cópia falhou devido a espaço em buffer insuficiente. Dependendo do valor de dwFlags, o buffer de destino pode conter uma versão truncada e terminada em nulo do resultado pretendido. Em situações em que o truncamento é aceitável, isso pode não ser necessariamente visto como uma condição de falha.
 

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

Comentários

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

Para obter mais informações sobre va_lists, consulte as convenções definidas em Stdarg.h.

O comportamento será indefinido se as cadeias de caracteres apontadas por pszDest, pszFormat ou quaisquer cadeias de caracteres de argumento se sobrepõem.

Nem pszFormat nem pszDest devem ser NULL , a menos que o sinalizador STRSAFE_IGNORE_NULLS seja especificado; nesse caso, ambos podem ser NULL. No entanto, um erro devido ao espaço insuficiente ainda pode ser retornado, embora os valores NULL sejam ignorados.

StringCchVPrintfEx 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” StringCchVPrintfExA
TCHAR TEXT("string") StringCchVPrintfEx
WCHAR L"string" StringCchVPrintfExW
 

Observação

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

StringCbVPrintfEx

StringCchPrintfEx

StringCchVPrintf