Função StringCchVPrintfExW (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. Sinalizadores também podem ser passados para a função para controle adicional.
StringCchVPrintfEx é uma substituição para as seguintes funções:
- vsprintf, vswprintf, _vstprintf
- vsnprintf, _vsnwprintf, _vsntprintf
- wvsprintf
- wvnsprintf
Sintaxe
STRSAFEAPI StringCchVPrintfExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[out, optional] STRSAFE_LPWSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags,
[in] STRSAFE_LPCWSTR 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 a partir 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 permitido é STRSAFE_MAX_CCH.
[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.
[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 de Sintaxe de Especificação de Formato.
[in] argList
Tipo: va_list
Os argumentos a serem inseridos na cadeia de caracteres pszFormat
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 |
|---|---|
|
Havia espaço suficiente para que o resultado fosse copiado para pszDest sem truncamento e o buffer foi encerrado em nulo. |
|
O valor em cchDest é 0 ou maior que STRSAFE_MAX_CCHou o buffer de destino já está cheio. |
|
A operação de cópia falhou devido ao 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, diferentemente das funções que ela substitui.
Observações
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 sobrecargas de buffer. StringCchVPrintfEx sempre termina 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, pszFormatou 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 valores de 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 de cadeia de caracteres | Literal de cadeia de caracteres | Função |
|---|---|---|
| char | "string" | stringCchVPrintfExA |
| TCHAR | TEXT("string") | StringCchVPrintfEx |
| WCHAR | L"string" | stringCchVPrintfExW |
Nota
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 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