Función RtlUnicodeStringVPrintf (ntstrsafe.h)

  • Artículo

La función RtlUnicodeStringVPrintf crea una cadena de texto, con formato basado en la información de formato proporcionada y almacena la cadena en una estructura de UNICODE_STRING .

Sintaxis

NTSTRSAFEDDI RtlUnicodeStringVPrintf(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

Parámetros

[out] DestinationString

Puntero a una estructura UNICODE_STRING que recibe una cadena con formato. RtlUnicodeStringVPrintf crea esta cadena a partir de la cadena de formato que pszFormat especifica y la lista de argumentos de la función. El número máximo de caracteres de la cadena es NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in] pszFormat

Puntero a una cadena de texto terminada en null que contiene directivas de formato con estilo printf.

[in] argList

Lista de argumentos con tipo va_list. Los argumentos de esta lista de argumentos se interpretarán mediante la cadena de formato que pszFormat especifica.

Valor devuelto

RtlUnicodeStringVPrintf devuelve uno de los siguientes valores NTSTATUS.

Código devuelto Descripción
STATUS_SUCCESS
 Este estado correcto significa que los datos de origen están presentes, la cadena se copió sin truncamiento y el búfer de destino resultante termina en null.
STATUS_BUFFER_OVERFLOW
 Este estado de advertencia significa que la operación de copia no se completó debido a un espacio de búfer insuficiente. El búfer de destino contiene una versión truncada terminada en NULL del resultado previsto.
STATUS_INVALID_PARAMETER
 Este estado de error significa que la función recibió un parámetro de entrada no válido. Para obtener más información, vea el siguiente párrafo.
 

RtlUnicodeStringVPrintf devuelve el valor STATUS_INVALID_PARAMETER cuando se produce una de las siguientes acciones:

  • El contenido de la estructura de UNICODE_STRING a la que apunta DestinationString no es válido.
  • El búfer de destino ya está lleno.
  • Hay un puntero NULL .
  • La longitud del búfer de destino es cero, pero existe una cadena de origen de longitud distinta de cero.
Para obtener información sobre cómo probar valores NTSTATUS, vea Uso de valores NTSTATUS.

Comentarios

La función RtlUnicodeStringVPrintf usa el tamaño del búfer de destino para asegurarse de que la operación de formato de cadena no escribe más allá del final del búfer. La función no finaliza la cadena resultante con un carácter nulo.

Si la cadena de formato y la cadena de destino se superponen, el comportamiento de la función no está definido.

Los punteros pszFormat y DestinationString no pueden ser NULL. Si necesita controlar valores de puntero NULL , use la función RtlUnicodeStringVPrintfEx .

Para obtener más información sobre las funciones de cadena segura, consulte Uso de funciones de cadena segura.

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows.
Plataforma de destino Escritorio
Encabezado ntstrsafe.h (incluya Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Consulte también

RtlUnicodeStringPrintf

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintfEx

UNICODE_STRING