Função RtlStringCbPrintfA (ntstrsafe.h)
As funções RtlStringCbPrintfW e RtlStringCbPrintfA criam uma cadeia de caracteres de texto contada por bytes, com formatação baseada em informações de formatação fornecidas.
Sintaxe
NTSTRSAFEDDI RtlStringCbPrintfA(
[out] NTSTRSAFE_PSTR pszDest,
[in] size_t cbDest,
[in] NTSTRSAFE_PCSTR pszFormat,
...
);
Parâmetros
[out] pszDest
Um ponteiro para um buffer fornecido pelo chamador que recebe uma cadeia de caracteres formatada e terminada em nulo. A função cria essa cadeia de caracteres com base na cadeia de caracteres de formatação fornecida pelo pszFormat e pela lista de argumentos da função.
[in] cbDest
O tamanho do buffer de destino, em bytes. O buffer deve ser grande o suficiente para conter a cadeia de caracteres formatada mais o caractere nulo de terminação.
Para cadeias de caracteres Unicode, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(WCHAR).
Para cadeias de caracteres ANSI, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(char).
[in] pszFormat
Um ponteiro para uma cadeia de caracteres de texto terminada em nulo que contém diretivas de formatação com estiloprintf.
...
Uma lista de argumentos que são interpretados pela função com base nas diretivas de formatação contidas na cadeia de caracteres pszFormat .
Retornar valor
A função retorna um dos valores NTSTATUS listados na tabela a seguir. Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.
| Código de retorno | Descrição |
|---|---|
|
Esse êxito status significa que os dados de origem estavam presentes, a cadeia de caracteres foi criada sem truncamento e o buffer de destino resultante foi encerrado em nulo. |
|
Esse aviso status significa que a operação não foi concluída devido a espaço insuficiente no buffer de destino. O buffer de destino contém uma versão truncada da cadeia de caracteres de saída. |
|
Esse erro status significa que a função recebeu um parâmetro de entrada inválido. Para obter mais informações, consulte o parágrafo a seguir.
A função retorna o valor STATUS_INVALID_PARAMETER quando:
|
Comentários
RtlStringCbPrintfW e RtlStringCbPrintfA devem ser usados em vez das seguintes funções:
- sprintf
- swprintf
- _snprintf
- _snwprintf
Use RtlStringCbPrintfW para manipular cadeias de caracteres Unicode e RtlStringCbPrintfA para manipular cadeias de caracteres ANSI. O formulário usado depende de seus dados, conforme mostrado na tabela a seguir.
| Tipos de dados de cadeia de caracteres | Cadeia de caracteres literal | Função |
|---|---|---|
| WCHAR | L"string" | RtlStringCbPrintfW |
| char | “cadeia de caracteres” | RtlStringCbPrintfA |
Se pszDest e pszFormat apontarem para uma cadeia de caracteres sobreposta ou se alguma cadeia de caracteres de argumento se sobrepor, o comportamento da função será indefinido.
Nem pszFormat nem pszDest podem ser NULL. Se você precisar manipular valores de ponteiro de cadeia de caracteres NULL , use RtlStringCbPrintfEx.
Para obter mais informações sobre as funções de cadeia de caracteres seguras, consulte Usando funções de cadeia de caracteres seguras.
Exemplos
O exemplo a seguir mostra um uso básico de RtlStringCbPrintfW usando quatro argumentos.
int const arraysize = 30;
WCHAR pszDest[arraysize];
size_t cbDest = arraysize * sizeof(WCHAR);
LPCWSTR pszFormat = L"%s %d + %d = %d.";
WCHAR* pszTxt = L"The answer is";
NTSTATUS status = RtlStringCbPrintfW(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);
A cadeia de caracteres resultante é "A resposta é 1 + 2 = 3". Ele está contido no buffer em pszDest.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Disponível a partir do Windows XP com Service Pack 1 (SP1). |
| Plataforma de Destino | Área de Trabalho |
| Cabeçalho | ntstrsafe.h (inclua Ntstrsafe.h) |
| Biblioteca | Ntstrsafe.lib |
| IRQL | Qualquer se as cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL |