Función RtlUnicodeStringPrintfEx (ntstrsafe.h)

Artículo
08/07/2023

La función RtlUnicodeStringPrintfEx 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 RtlUnicodeStringPrintfEx(
  [out]           PUNICODE_STRING  DestinationString,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags,
  [in]            NTSTRSAFE_PCWSTR pszFormat,
                  ...              
);

Parámetros

[out] DestinationString

Opcional. Puntero a una estructura UNICODE_STRING que recibe una cadena con formato. RtlUnicodeStringPrintfEx 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. DestinationString puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

[out, optional] RemainingString

Opcional. Si el llamador proporciona un puntero distinto de NULL a una estructura de UNICODE_STRING , RtlUnicodeStringPrintfEx establece el miembro Buffer de esta estructura al final de la cadena con formato, establece el miembro Length de la estructura en cero y establece el miembro MaximumLength de la estructura en el número de bytes que quedan en el búfer de destino. RemainingString puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

[in] dwFlags

Una o varias marcas y, opcionalmente, un byte de relleno. Las marcas se definen de la siguiente manera:

STRSAFE_FILL_BEHIND

Si se establece esta marca y la función se ejecuta correctamente, el byte bajo de dwFlags se usa para rellenar la parte del búfer de destino que sigue al último carácter de la cadena.

STRSAFE_IGNORE_NULLS

Si se establece esta marca, el puntero de origen o destino, o ambos, puede ser NULL. RtlUnicodeStringPrintfEx trata punteros de búfer de origen NULL como cadenas vacías (TEXT("")), que se pueden copiar. Los punteros de búfer de destino NULL no pueden recibir cadenas no vacías.

STRSAFE_FILL_ON_FAILURE

Si se establece esta marca y se produce un error en la función, el byte bajo de dwFlags se usa para rellenar todo el búfer de destino. Esta operación sobrescribe cualquier contenido de búfer preexistente.

STRSAFE_NULL_ON_FAILURE

Si se establece esta marca y se produce un error en la función, el búfer de destino se establece en una cadena vacía (TEXT("")). Esta operación sobrescribe cualquier contenido de búfer preexistente.

STRSAFE_NO_TRUNCATION

Si se establece esta marca y la función devuelve STATUS_BUFFER_OVERFLOW, no se modifica el contenido del búfer de destino.

STRSAFE_ZERO_LENGTH_ON_FAILURE

Si se establece esta marca y la función devuelve STATUS_BUFFER_OVERFLOW, la longitud de la cadena de destino se establece en cero bytes.

[in] pszFormat

Puntero a una cadena de texto terminada en null que contiene directivas de formato con estilo printf. Este puntero puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

...

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

Valor devuelto

RtlUnicodeStringPrintfEx devuelve uno de los siguientes valores NTSTATUS.

Código devuelto	Descripción
STATUS_SUCCESS	Este estado correcto significa que los datos de origen estaban presentes y las cadenas se concatenaron sin truncamiento.
STATUS_BUFFER_OVERFLOW	Este estado de advertencia significa que la operación no se completó debido a un espacio insuficiente en el búfer de destino. Si STRSAFE_NO_TRUNCATION se establece en dwFlags, el búfer de destino no se modifica. Si no se establece la marca, el búfer de destino contiene una versión truncada de la cadena copiada.
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, consulte la lista siguiente.

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

El contenido de una estructura de UNICODE_STRING no es válido.
Se especifica una marca no válida en dwFlags.
El búfer de destino ya está lleno.
Un puntero de búfer es NULL y la marca STRSAFE_IGNORE_NULLS no se especifica en dwFlags.
El puntero del búfer de destino es NULL, pero el tamaño del búfer no es cero.
El puntero del búfer de destino es NULL o su longitud 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 RtlUnicodeStringPrintfEx 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. De forma predeterminada, la función no finaliza la cadena resultante con un valor de carácter nulo (es decir, con cero). Como opción, el autor de la llamada puede usar la marca STRSAFE_FILL_BEHIND y un valor de byte de relleno de cero para terminar en null una cadena resultante que no ocupa todo el búfer de destino.

RtlUnicodeStringPrintfEx agrega a la funcionalidad de la función RtlUnicodeStringPrintf devolviendo una estructura UNICODE_STRING que identifica el final de la cadena de destino y el número de bytes que quedan sin usar en esa cadena. Puede pasar marcas a RtlUnicodeStringPrintfEx para un control adicional.

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 a menos que la marca de STRSAFE_IGNORE_NULLS esté establecida en dwFlags. Si se establece STRSAFE_IGNORE_NULLS, uno o ambos punteros pueden ser NULL. Si el puntero DestinationString es NULL, el puntero pszFormat debe ser NULL o apuntar a una cadena vacía.

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 a partir de Windows XP con Service Pack 1 (SP1).
Plataforma de destino	Escritorio
Encabezado	ntstrsafe.h (incluya Ntstrsafe.h)
Library	Ntstrsafe.lib
IRQL	PASSIVE_LEVEL