Compartir a través de

Función RtlStringCbVPrintfA (ntstrsafe.h)

  • Artículo

Las funciones RtlStringCbVPrintfW y RtlStringCbVPrintfA crean una cadena de texto con recuento de bytes, con formato basado en la información de formato proporcionada.

Sintaxis

NTSTRSAFEDDI RtlStringCbVPrintfA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  NTSTRSAFE_PCSTR 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.

[in] cbDest

Tamaño del búfer de destino, en bytes. El búfer debe ser lo suficientemente grande como para contener la cadena con formato más el carácter nulo de terminación.

Para las cadenas Unicode, el número máximo de bytes es NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Para las cadenas ANSI, el número máximo de bytes es NTSTRSAFE_MAX_CCH * sizeof(char).

[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 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 Uso de valores NTSTATUS.

Código devuelto Descripción
STATUS_SUCCESS
 Este estado correcto significa que los datos de origen están presentes, la cadena de salida se creó sin truncamiento y el búfer de destino resultante termina en null.
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. El búfer de destino contiene una versión truncada de la cadena creada.
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 el párrafo siguiente.

La función devuelve el valor STATUS_INVALID_PARAMETER cuando:

  • El valor de cbDest es mayor que el tamaño máximo del búfer.
  • El búfer de destino ya estaba lleno.
  • Había un puntero NULL .
  • La longitud del búfer de destino era cero, pero había una cadena de origen de longitud distinta de cero.

Comentarios

Se debe usar RtlStringCbVPrintfW y RtlStringCbVPrintfA en lugar de las siguientes funciones:

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
Todas estas funciones aceptan una cadena de formato, junto con un conjunto de argumentos en una lista de argumentos con tipo va_list y devuelven una cadena con formato. El tamaño, en bytes, del búfer de destino se proporciona a RtlStringCbVPrintfW y RtlStringCbVPrintfA para asegurarse de que no escriben más allá del final del búfer.

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

Use RtlStringCbVPrintfW para controlar cadenas Unicode y RtlStringCbVPrintfA para controlar cadenas ANSI. El formulario que use depende de los datos, como se muestra en la tabla siguiente.

Tipo de datos String Literal de cadena Función
WCHAR L"string" RtlStringCbVPrintfW
char "cadena" RtlStringCbVPrintfA
 

Si pszDest y pszFormat apuntan a cadenas superpuestas o si se superponen cadenas de argumentos, el comportamiento de la función es indefinido.

Ni pszFormat ni pszDest deben ser NULL. Si necesita controlar valores de puntero de cadena NULL , use RtlStringCbVPrintfEx.

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 Si las cadenas que se manipulan siempre residen en la memoria, de lo contrario, PASSIVE_LEVEL

Consulte también

RtlStringCbPrintf

RtlStringCbVPrintfEx

RtlStringCchVPrintf