Função StringCbPrintfA (strsafe.h)

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

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

• sprintf, swprintf, _stprintf
• wsprintf
• wnsprintf
• _snprintf, _snwprintf, _sntprintf

Sintaxe

STRSAFEAPI StringCbPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

Parâmetros

[out] pszDest

Tipo: LPSTR

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

[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: LPCSTR

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.

...

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.

Observe que essa função retorna um valor HRESULT, diferentemente das funções que ela substitui.

Observações

Em comparação com as funções que ele substitui, stringCbPrintf 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. StringCbPrintf sempre termina um buffer de destino diferente de zero.

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

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

Exemplos

O exemplo a seguir mostra um uso básico de StringCbPrintf, usando quatro argumentos.

int const arraysize = 30;
TCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(TCHAR);

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCbPrintf(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

Requisitos

Consulte também

de referência de

StringCbPrintfEx

StringCbVPrintf

StringCchPrintf