Função StringCbPrintfExA (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.
StringCbPrintfEx adiciona à funcionalidade de StringCbPrintf retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de bytes deixados não utilizados nessa cadeia de caracteres. Os sinalizadores também podem ser passados para a função para controle adicional.
StringCbPrintfEx é uma substituição para as seguintes funções:
Sintaxe
STRSAFEAPI StringCbPrintfExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags,
[in] STRSAFE_LPCSTR pszFormat,
...
);
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 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).
[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] pcbRemaining
Tipo: size_t*
O número de bytes não utilizados no pszDest, incluindo aqueles usados para o caractere nulo de terminação. Se pcbRemaining 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 Sintaxe de especificação de formato.
...
Os argumentos a serem inseridos na cadeia de caracteres pszFormat .
Retornar valor
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 |
|---|---|
|
Havia espaço suficiente para que o resultado fosse copiado para pszDest sem truncamento e o buffer fosse encerrado em nulo. |
|
O valor em cbDest é 0 ou maior que STRSAFE_MAX_CCH * sizeof(TCHAR)ou o buffer de destino já está cheio.
|
|
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
Em comparação com as funções que ele substitui, StringCbPrintfEx 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. StringCbPrintfEx sempre termina em nulo um buffer de destino diferente de zero.
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.
StringCbPrintfEx 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.
| Tipo de dados da cadeia de caracteres | Literal da cadeia de caracteres | Função |
|---|---|---|
| char | “cadeia de caracteres” | StringCbPrintfExA |
| TCHAR | TEXT("string") | StringCbPrintfEx |
| WCHAR | L"string" | StringCbPrintfExW |
Observação
O cabeçalho strsafe.h define StringCbPrintfEx 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
| Requisito | Valor |
|---|---|
| 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