Función RtlUnicodeStringPrintf (ntstrsafe.h)

La función rtlUnicodeStringPrintf 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 RtlUnicodeStringPrintf(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
        ...              
);

Parámetros

[out] DestinationString

Puntero a una estructura UNICODE_STRING que recibe una cadena con formato. rtlUnicodeStringPrintf 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 printfdirectivas de formato con estilo .

...

Opcional. Lista de argumentos que interpreta la función, en función de las directivas de formato que contiene la cadena de pszFormat.

Valor devuelto

rtlUnicodeStringPrintf devuelve uno de los siguientes valores NTSTATUS.

Código devuelto	Descripción
STATUS_SUCCESS	Este correcto estado significa que los datos de origen se encontraban presentes, la cadena se copió sin truncamiento y el búfer de destino resultante está terminado en null.
STATUS_BUFFER_OVERFLOW	Esta advertencia estado significa que la operación 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 error estado significa que la función recibió un parámetro de entrada no válido. Para obtener más información, consulte la lista siguiente.

 

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

• El contenido de la estructura UNICODE_STRING a la que apunta el parámetro 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 Using NTSTATUS Values.

Observaciones

La función RtlUnicodeStringPrintf 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 NULL.

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

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

Para obtener más información sobre las funciones de cadena segura, vea Using Safe String Functions.

Requisitos

Requisito	Valor
cliente mínimo admitido	Disponible en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows.
de la plataforma de destino de	Escritorio
encabezado de	ntstrsafe.h (incluya Ntstrsafe.h)
biblioteca de	Ntstrsafe.lib
irQL	Si las cadenas que se manipulan siempre residen en la memoria, de lo contrario, PASSIVE_LEVEL

Consulte también

rtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintf

rtlUnicodeStringVPrintfEx

UNICODE_STRING