Função StringCbVPrintfW (strsafe.h)

Artigo
11/20/2024

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.

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

Sintaxe

STRSAFEAPI StringCbVPrintfW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cbDest,
  [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] cbDest

Tipo: size_t

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

[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
S_OK	Havia espaço suficiente para que o resultado fosse copiado para pszDest sem truncamento e o buffer foi encerrado em nulo.
STRSAFE_E_INVALID_PARAMETER	O valor em cbDest é 0 ou maior que `STRSAFE_MAX_CCH * sizeof(TCHAR)`.
STRSAFE_E_INSUFFICIENT_BUFFER	A operação de cópia falhou devido ao espaço em buffer insuficiente. O buffer de destino contém 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

StringCbVPrintf 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. StringCbVPrintf 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. Consulte StringCbVPrintfEx se você precisar lidar com valores nulos de ponteiro de cadeia de caracteres.

stringCbVPrintf 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"	StringCbVPrintfA
TCHAR	TEXT("string")	StringCbVPrintf
WCHAR	L"string"	StringCbVPrintfW

Nota

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

StringCbPrintf

stringCbVPrintfEx

StringCchVPrintf

Compartilhar via