Função RtlStringCbPrintfExA (ntstrsafe.h)

  • Artigo

As funções RtlStringCbPrintfExW e RtlStringCbPrintfExA criam uma cadeia de caracteres de texto contada por bytes, com formatação baseada em informações de formatação fornecidas.

Sintaxe

NTSTRSAFEDDI RtlStringCbPrintfExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cbDest,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags,
  [in, optional]  NTSTRSAFE_PCSTR pszFormat,
                  ...             
);

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 pelo pszFormat e da lista de argumentos da função. 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:

Valor Significado
STRSAFE_FILL_BEHIND_NULL
Se definido e a função tiver êxito, o byte baixo de dwFlags será usado para preencher a parte do buffer de destino que segue o caractere nulo de terminação.
STRSAFE_IGNORE_NULLS
Se definido, pszDest ou pszSrc ou ambos poderão ser NULL. Os ponteiros null pszSrc são tratados como cadeias de caracteres vazias (TEXT("")), que podem ser copiadas. Os ponteiros null pszDest não podem receber cadeias de caracteres nãompty.
STRSAFE_FILL_ON_FAILURE
Se definido e a função falharem, o byte baixo de dwFlags será usado para preencher todo o buffer de destino e o buffer será encerrado em nulo. Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NULL_ON_FAILURE
Se 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 definido e a função retornar STATUS_BUFFER_OVERFLOW, o conteúdo do buffer de destino não será modificado.

[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.

...

Uma lista de argumentos 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
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 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 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:

  • Um sinalizador inválido foi especificado.
  • O valor em cbDest é maior que o tamanho máximo do buffer.
  • O buffer de destino já estava cheio.
  • Um ponteiro NULL estava presente sem o sinalizador STRSAFE_IGNORE_NULLS.
  • O ponteiro do buffer de destino era NULL, mas o tamanho do buffer não era zero.
  • O ponteiro do buffer de destino era NULL ou seu comprimento era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

Comentários

RtlStringCbPrintfExW e RtlStringCbPrintfExA devem ser usados em vez das seguintes funções:

  • sprintf
  • swprintf
  • _snprintf
  • _snwprintf
Todas essas funções aceitam uma cadeia de caracteres de formato e uma lista de argumentos, interpretam-nas e criam uma cadeia de caracteres formatada. O tamanho, em bytes, do buffer de destino é fornecido a RtlStringCbPrintfExW e RtlStringCbPrintfExA para garantir que eles não escrevam após o final do buffer.

RtlStringCbPrintfExW e RtlStringCbPrintfExA adicionam à funcionalidade de RtlStringCbPrintf 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.

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

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 a partir do Windows XP com o Service Pack 1 (SP1).
Plataforma de Destino Área de Trabalho
Cabeçalho ntstrsafe.h (inclua Ntstrsafe.h)
Biblioteca Ntstrsafe.lib
IRQL Qualquer se cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Confira também

RtlStringCbVPrintfEx

RtlStringCchPrintf

RtlStringCchPrintfEx