Função RtlStringCchVPrintfA (ntstrsafe.h)

  • Artigo

As funções RtlStringCchVPrintfW e RtlStringCchVPrintfA criam uma cadeia de caracteres de texto contada com caracteres, com formatação baseada em informações de formatação fornecidas.

Sintaxe

NTSTRSAFEDDI RtlStringCchVPrintfA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszFormat,
  [in]  va_list         argList
);

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 a partir da cadeia de caracteres de formatação fornecida por pszFormat e dos argumentos fornecidos por argList.

[in] cchDest

O tamanho do buffer de destino, em caracteres. O buffer deve ser grande o suficiente para conter a cadeia de caracteres formatada mais o caractere nulo de terminação. O número máximo de caracteres permitido é NTSTRSAFE_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.

[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
STATUS_SUCCESS
 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.
STATUS_BUFFER_OVERFLOW
 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 criada.
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 o parágrafo a seguir.

A função retorna o valor STATUS_INVALID_PARAMETER quando:

  • O valor em cchDest é maior que o tamanho máximo do buffer.
  • O buffer de destino já estava cheio.
  • Um ponteiro NULL estava presente.
  • O comprimento do buffer de destino era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

Comentários

RtlStringCchVPrintfW e RtlStringCchVPrintfA devem ser usados em vez das seguintes funções:

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
Todas essas funções aceitam uma cadeia de caracteres de formato e seus argumentos, que são fornecidos como uma lista de argumentos tipo va_list e retornam uma cadeia de caracteres formatada. RtlStringCchVPrintfW e RtlStringCchVPrintfA recebem o tamanho, em caracteres, do buffer de destino para garantir que as funções não sejam gravadas após o final do buffer.

Para obter mais informações sobre listas de argumentos com tipo va_list, consulte a documentação do SDK do Microsoft Windows.

Use RtlStringCchVPrintfW para manipular cadeias de caracteres Unicode e RtlStringCchVPrintfA 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" RtlStringCchVPrintfW
char “cadeia de caracteres” RtlStringCchVPrintfA
 

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. Se você precisar manipular valores de ponteiro de cadeia de caracteres NULL , use RtlStringCchVPrintfEx.

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

RtlStringCbVPrintf

RtlStringCchPrintf

RtlStringCchVPrintfEx