Função RtlUnicodeStringPrintf (ntstrsafe.h)

  • Artigo

A função RtlUnicodeStringPrintf 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 RtlUnicodeStringPrintf(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
        ...              
);

Parâmetros

[out] DestinationString

Um ponteiro para uma estrutura UNICODE_STRING que recebe uma cadeia de caracteres formatada. RtlUnicodeStringPrintf 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.

[in] pszFormat

Um ponteiro para uma cadeia de caracteres de texto terminada em nulo que contém diretivas de formatação com estilo printf.

...

Opcional. Uma lista de argumentos que a função interpreta, com base nas diretivas de formatação que a cadeia de caracteres pszFormat contém.

Retornar valor

RtlUnicodeStringPrintf retorna um dos seguintes valores NTSTATUS.

Código de retorno Descrição
STATUS_SUCCESS
 Esse êxito status significa que os dados de origem estavam presentes, a cadeia de caracteres foi copiada sem truncamento e o buffer de destino resultante foi encerrado em nulo.
STATUS_BUFFER_OVERFLOW
 Esse aviso status significa que a operação não foi concluída devido a espaço em buffer insuficiente. O buffer de destino contém uma versão truncada e terminada em nulo do resultado pretendido.
STATUS_INVALID_PARAMETER
 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.
 

RtlUnicodeStringPrintf retorna o valor STATUS_INVALID_PARAMETER quando ocorre um dos seguintes:

  • O conteúdo da estrutura UNICODE_STRING para a qual o parâmetro DestinationString aponta é inválido.
  • O buffer de destino já está cheio.
  • Um ponteiro NULL está presente.
  • O comprimento do buffer de destino é zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero está presente.
Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.

Comentários

A função RtlUnicodeStringPrintf 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. A função não encerra a cadeia de caracteres resultante com um caractere nulo.

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. Se você precisar manipular valores de ponteiro NULL , use a função RtlUnicodeStringPrintfEx .

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

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintf

RtlUnicodeStringVPrintfEx

UNICODE_STRING