Função RtlUnicodeStringPrintfEx (ntstrsafe.h)
A função RtlUnicodeStringPrintfEx cria uma cadeia de caracteres de texto, com formatação baseada em informações de formatação fornecidas, e armazena a cadeia de caracteres em uma estrutura UNICODE_STRING .
Sintaxe
NTSTRSAFEDDI RtlUnicodeStringPrintfEx(
[out] PUNICODE_STRING DestinationString,
[out, optional] PUNICODE_STRING RemainingString,
[in] DWORD dwFlags,
[in] NTSTRSAFE_PCWSTR pszFormat,
...
);
Parâmetros
[out] DestinationString
Opcional. Um ponteiro para uma estrutura UNICODE_STRING que recebe uma cadeia de caracteres formatada. RtlUnicodeStringPrintfEx cria essa cadeia de caracteres com base na cadeia de caracteres de formatação especificada por pszFormat e na lista de argumentos da função. O número máximo de caracteres na cadeia de caracteres é NTSTRSAFE_UNICODE_STRING_MAX_CCH. DestinationString pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.
[out, optional] RemainingString
Opcional. Se o chamador fornecer um ponteiro não NULL para uma estrutura UNICODE_STRING , RtlUnicodeStringPrintfEx definirá o membro Buffer dessa estrutura como o final da cadeia de caracteres formatada, definirá o membro Length da estrutura como zero e definirá o membro MaximumLength da estrutura como o número de bytes restantes no buffer de destino. RemainingString pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.
[in] dwFlags
Um ou mais sinalizadores e, opcionalmente, um byte de preenchimento. Os sinalizadores são definidos da seguinte maneira:
STRSAFE_FILL_BEHIND
Se esse sinalizador for definido e a função for bem-sucedida, o byte baixo de dwFlags será usado para preencher a parte do buffer de destino que segue o último caractere na cadeia de caracteres.
STRSAFE_IGNORE_NULLS
Se esse sinalizador estiver definido, o ponteiro de origem ou destino, ou ambos, poderá ser NULL. RtlUnicodeStringPrintfEx trata ponteiros de buffer de origem NULL como cadeias de caracteres vazias (TEXT("")), que podem ser copiadas. Os ponteiros de buffer de destino NULL não podem receber cadeias de caracteres não vazias.
STRSAFE_FILL_ON_FAILURE
Se esse sinalizador for definido e a função falhar, o byte baixo de dwFlags será usado para preencher todo o buffer de destino. Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NULL_ON_FAILURE
Se esse sinalizador for definido e a função falhar, o buffer de destino será definido como uma cadeia de caracteres vazia (TEXT("")). Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NO_TRUNCATION
Se esse sinalizador for definido e a função retornar STATUS_BUFFER_OVERFLOW, o conteúdo do buffer de destino não será modificado.
STRSAFE_ZERO_LENGTH_ON_FAILURE
Se esse sinalizador for definido e a função retornar STATUS_BUFFER_OVERFLOW, o comprimento da cadeia de caracteres de destino será definido como zero bytes.
[in] pszFormat
Um ponteiro para uma cadeia de caracteres de texto terminada em nulo que contém diretivas de formatação com estilo printf. Esse ponteiro pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.
...
Opcional. Uma lista de argumentos que RtlUnicodeStringPrintfEx interpreta, com base nas diretivas de formatação especificadas pela cadeia de caracteres pszFormat .
Retornar valor
RtlUnicodeStringPrintfEx retorna um dos seguintes valores NTSTATUS.
| Código de retorno | Descrição |
|---|---|
|
Esse sucesso status significa que os dados de origem estavam presentes e as cadeias de caracteres foram concatenadas sem truncamento. |
|
Esse aviso status significa que a operação não foi concluída devido ao 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 copiada. |
|
Esse erro status significa que a função recebeu um parâmetro de entrada inválido. Para obter mais informações, consulte a lista a seguir. |
RtlUnicodeStringPrintfEx retorna o valor STATUS_INVALID_PARAMETER quando ocorre um dos seguintes:
- O conteúdo de uma estrutura UNICODE_STRING é inválido.
- Um sinalizador inválido é especificado em dwFlags.
- O buffer de destino já está cheio.
- Um ponteiro de buffer é NULL e o sinalizador STRSAFE_IGNORE_NULLS não é especificado em dwFlags.
- O ponteiro do buffer de destino é NULL, mas o tamanho do buffer não é zero.
- O ponteiro do buffer de destino é NULL ou seu comprimento é zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero está presente.
Comentários
A função RtlUnicodeStringPrintfEx usa o tamanho do buffer de destino para garantir que a operação de formatação de cadeia de caracteres não seja gravada após o final do buffer. Por padrão, a função não encerra a cadeia de caracteres resultante com um valor de caractere nulo (ou seja, com zero). Como opção, o chamador pode usar o sinalizador STRSAFE_FILL_BEHIND e um valor de byte de preenchimento de zero para encerrar nulo uma cadeia de caracteres resultante que não ocupa todo o buffer de destino.
RtlUnicodeStringPrintfEx adiciona à funcionalidade da função RtlUnicodeStringPrintf retornando uma estrutura UNICODE_STRING que identifica o final da cadeia de caracteres de destino e o número de bytes que são deixados não utilizados nessa cadeia de caracteres. Você pode passar sinalizadores para RtlUnicodeStringPrintfEx para controle adicional.
Se a cadeia de caracteres de formato e a cadeia de caracteres de destino se sobrepõem, o comportamento da função será indefinido.
Os ponteiros pszFormat e DestinationString não podem ser NULL , a menos que o sinalizador STRSAFE_IGNORE_NULLS esteja definido em dwFlags. Se STRSAFE_IGNORE_NULLS estiver definido, um ou ambos os ponteiros poderão ser NULL. Se o ponteiro DestinationString for NULL, o ponteiro 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 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 | PASSIVE_LEVEL |
Confira também
Comentários
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, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de