Compartir a través de

Función RtlStringCchVPrintfW (ntstrsafe.h)

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

Sintaxis

NTSTRSAFEDDI RtlStringCchVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  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.

[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.

[in] pszFormat

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

[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. 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:

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

Observaciones

rtlStringCchVPrintfW y RtlStringCchVPrintfA deben usarse en lugar de las funciones siguientes:

  • vsprintf
  • vswprintf
  • _ vsnprintf
  • _vsnwprintf
Todas estas funciones aceptan una cadena de formato y sus argumentos, que se proporcionan como una lista de argumentos con tipo va_listy devuelven una cadena con formato. rtlStringCchVPrintfW y RtlStringCchVPrintfA recibir el tamaño, en caracteres, del búfer de destino para asegurarse de que las funciones no escriben más allá del final del búfer.

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

Use RtlStringCchVPrintfW para controlar cadenas Unicode y RtlStringCchVPrintfA 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" rtlStringCchVPrintfW
char "string" RtlStringCchVPrintfA
 

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.

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

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

RtlStringCbVPrintf

RtlStringCchPrintf

rtlStringCchVPrintfEx

  • Last updated on