Función RtlStringCchVPrintfExW (ntstrsafe.h)

Artículo
07/16/2024

Las funciones RtlStringCchVPrintfExW y RtlStringCchVPrintfExA crean una cadena de texto con recuento de caracteres, con formato basado en la información de formato proporcionada.

Sintaxis

NTSTRSAFEDDI RtlStringCchVPrintfExW(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags,
  [in, optional]  NTSTRSAFE_PCWSTR pszFormat,
  [in]            va_list          argList
);

Parámetros

[out] pszDest

Puntero a un búfer proporcionado por el autor de la llamada que recibe una cadena con formato terminada en NULL. La función crea esta cadena a partir de la cadena de formato proporcionada por pszFormat y los argumentos proporcionados por argList. El puntero pszDest de puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS se establece en dwFlags.

[in] cchDest

Tamaño del búfer de destino, en caracteres. El búfer debe ser lo suficientemente grande como para contener la cadena con formato más el carácter nulo de terminación. El número máximo de caracteres permitido es NTSTRSAFE_MAX_CCH. Si pszDest es NULL, cchDest debe ser cero.

[out, optional] ppszDestEnd

Si el autor de la llamada proporciona un puntero de dirección que no esNULL, una vez completada la operación, la función carga esa dirección con un puntero al terminador de cadena null resultante del búfer de destino.

[out, optional] pcchRemaining

Si el autor de la llamada proporciona un puntero de dirección que no esNULL, la función carga la dirección con el número de bytes sin usar que se encuentran en el búfer al que apunta pszDest, incluidos los bytes usados para el carácter nulo de terminación.

[in] dwFlags

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

Valor	Significado
STRSAFE_FILL_BEHIND_NULL	Si se establece 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 carácter nulo de terminación.
STRSAFE_IGNORE_NULLS	Si se establece, pszDest puede ser NULL. punterospszDest NULL no pueden recibir cadenas no vacías.
STRSAFE_FILL_ON_FAILURE	Si se produce un error en set y la función, se usa el byte bajo de dwFlags para rellenar todo el búfer de destino y el búfer termina en null. Esta operación sobrescribe el contenido del búfer preexistente.
STRSAFE_NULL_ON_FAILURE	Si se establece 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 el contenido del búfer preexistente.
STRSAFE_NO_TRUNCATION	Si se establece y la función devuelve STATUS_BUFFER_OVERFLOW, no se modifica el contenido del búfer de destino.

[in, optional] pszFormat

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

[in] argList

Lista de argumentos con tipo va_list. Los argumentos contenidos en la lista de argumentos se interpretarán mediante la cadena de formato proporcionada por pszFormat.

Valor devuelto

La función devuelve uno de los valores NTSTATUS que se enumeran en la tabla siguiente. Para obtener información sobre cómo probar valores NTSTATUS, vea Using NTSTATUS Values.

Código devuelto	Descripción
STATUS_SUCCESS	Este correcto estado significa que los datos de origen están presentes, la cadena de salida se creó sin truncamiento y el búfer de destino resultante está terminado en null.
STATUS_BUFFER_OVERFLOW	Este advertencia estado 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, no se modifica el búfer de destino. Si no se establece la marca, el búfer de destino contiene una versión truncada de la cadena creada.
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 el párrafo siguiente. La función devuelve el valor de STATUS_INVALID_PARAMETER cuando: Se especificó una marca no válida. El valor de cchDest es mayor que el tamaño máximo del búfer. El búfer de destino ya estaba lleno. Un puntero NULL estaba presente sin la marca STRSAFE_IGNORE_NULLS. El puntero del búfer de destino se NULL, pero el tamaño del búfer no era cero. El puntero del búfer de destino se NULL, o su longitud era cero, pero había una cadena de origen de longitud distinta de cero.

Código devuelto

Descripción

STATUS_SUCCESS

Este correcto estado significa que los datos de origen están presentes, la cadena de salida se creó sin truncamiento y el búfer de destino resultante está terminado en null.

STATUS_BUFFER_OVERFLOW

Este advertencia estado 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, no se modifica el búfer de destino. Si no se establece la marca, el búfer de destino contiene una versión truncada de la cadena creada.

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 el párrafo siguiente.

La función devuelve el valor de STATUS_INVALID_PARAMETER cuando:

Se especificó una marca no válida.
El valor de cchDest es mayor que el tamaño máximo del búfer.
El búfer de destino ya estaba lleno.
Un puntero NULL estaba presente sin la marca STRSAFE_IGNORE_NULLS.
El puntero del búfer de destino se NULL, pero el tamaño del búfer no era cero.
El puntero del búfer de destino se NULL, o su longitud era cero, pero había una cadena de origen de longitud distinta de cero.

Observaciones

rtlStringCchVPrintfExW y rtlStringCchVPrintfExA deben usarse en lugar de las funciones siguientes:

vsprintf
vswprintf
_ vsnprintf
_vsnwprintf

Todas estas funciones aceptan una cadena de formato y sus argumentos, proporcionados como una lista de argumentos con tipo va_listy devuelven una cadena con formato. rtlStringCchVPrintfExW y RtlStringCchVPrintfExA recibir el tamaño, en caracteres, del búfer de destino para asegurarse de que no escriben más allá del final del búfer.

rtlStringCchVPrintfExW y RtlStringCchVPrintfExA agregar a la funcionalidad de RtlStringCchVPrintf devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que quedan sin usar en esa cadena. Las marcas se pueden pasar a la función para un control adicional.

Para obtener más información sobre va_listlistas de argumentos con tipo, consulte la documentación del SDK de Microsoft Windows.

Use RtlStringCchVPrintfExW para controlar cadenas Unicode y RtlStringCchVPrintfExA para controlar cadenas ANSI. El formulario que use depende de los datos.

Tipo de datos string	Literal de cadena	Función
WCHAR	L"string"	rtlStringCchVPrintfExW
char	"string"	RtlStringCchVPrintfExA

Si pszDest y pszFormat apuntar a cadenas superpuestas o si alguna cadena de argumento se superpone, el comportamiento de la función no está definido.

pszDest no se puede NULL a menos que se establezca la marca de STRSAFE_IGNORE_NULLS.

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

RtlStringCbVPrintfEx

rtlStringCchPrintfEx

rtlStringCchVPrintf

Compartir a través de