Função RtlStringCbVPrintfExW (ntstrsafe.h)
As funções RtlStringCbVPrintfExW e RtlStringCbVPrintfExA criam uma cadeia de caracteres de texto contada por bytes, com formatação baseada em informações de formatação fornecidas.
Sintaxe
NTSTRSAFEDDI RtlStringCbVPrintfExW(
[out, optional] NTSTRSAFE_PWSTR pszDest,
[in] size_t cbDest,
[out, optional] NTSTRSAFE_PWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags,
[in, optional] NTSTRSAFE_PCWSTR pszFormat,
[in] va_list argList
);
Parâmetros
[out, optional] 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 a partir da cadeia de caracteres de formatação fornecida por pszFormat e dos argumentos fornecidos por argList. O ponteiro pszDest pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.
[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).
Se pszDest for NULL, cbDest deverá ser zero.
[out, optional] ppszDestEnd
Se o chamador fornecer um ponteiro de endereço não NULL , depois que a operação for concluída, a função carregará esse endereço com um ponteiro para o terminador de cadeia de caracteres nula resultante do buffer de destino.
[out, optional] pcbRemaining
Se o chamador fornecer um ponteiro de endereço não NULL , a função carregará o endereço com o número de bytes não utilizados que estão no buffer apontado por pszDest, incluindo bytes usados para o caractere nulo de terminação.
[in] dwFlags
Um ou mais sinalizadores e, opcionalmente, um byte de preenchimento. Os sinalizadores são definidos da seguinte maneira:
[in, optional] pszFormat
Um ponteiro para uma cadeia de caracteres de texto terminada em nulo que contém diretivas de formatação com estilo printf. O ponteiro pszFormat pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.
[in] argList
Uma lista de argumentos com tipo va_list. Os argumentos contidos na lista de argumentos serão interpretados usando a cadeia de caracteres de formatação fornecida pelo 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 de saída 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. Se STRSAFE_NO_TRUNCATION estiver definido em dwFlags, o buffer de destino não será modificado. Se o sinalizador não estiver definido, o buffer de destino conterá uma versão truncada da cadeia de caracteres criada. |
|
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
RtlStringCbVPrintfExW e RtlStringCbVPrintfExA devem ser usados em vez das seguintes funções:
- vsprintf
- vswprintf
- _vsnprintf
- _vsnwprintf
RtlStringCbVPrintfExW e RtlStringCbVPrintfExA adicionam à funcionalidade de RtlStringCbVPrintf 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 podem ser passados para a função para controle adicional.
Para obter mais informações sobre listas de argumentos com tipo va_list, consulte a documentação do SDK do Microsoft Windows.
Use RtlStringCbVPrintfExW para manipular cadeias de caracteres Unicode e RtlStringCbVPrintfExA 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" | RtlStringCbVPrintfExW |
char | “cadeia de caracteres” | RtlStringCbVPrintfExA |
Se pszDest e pszFormat apontarem para cadeias de caracteres sobrepostas ou se alguma cadeia de caracteres de argumento se sobrepor, o comportamento da função será indefinido.
Nem pszFormat nem pszDest podem ser NULL , a menos que o sinalizador STRSAFE_IGNORE_NULLS esteja definido; nesse caso, ou ambos podem ser NULL. Se pszDest for NULL, pszFormat deverá ser NULL ou apontar para uma cadeia de caracteres vazia.
Para obter mais informações sobre as funções de cadeia de caracteres seguras, consulte Usando funções de cadeia de caracteres seguras.
Requisitos
Requisito | Valor |
---|---|
Cliente mínimo com suporte | Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows. |
Plataforma de Destino | Área de Trabalho |
Cabeçalho | ntstrsafe.h (inclua Ntstrsafe.h) |
Biblioteca | Ntstrsafe.lib |
IRQL | PASSIVE_LEVEL |
Confira também
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de