Función RtlStringCchPrintfA (ntstrsafe.h)

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

Sintaxis

NTSTRSAFEDDI RtlStringCchPrintfA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszFormat,
        ...             
);

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 la lista de argumentos de la función.

[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 directivas de formato con estilo printf.

...

Lista de argumentos interpretados por la función, en función de las directivas de formato contenidas en la cadena 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 se creó sin truncamiento y el búfer de destino resultante está terminado 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 de salida.
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 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 . 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 RtlStringCchPrintfW y RtlStringCchPrintfA en lugar de las siguientes funciones:

• sprintf
• swprintf
• _snprintf
• _snwprintf

Todas estas funciones aceptan una cadena de formato y una lista de argumentos y devuelven una cadena con formato. RtlStringCchPrintfW y RtlStringCchPrintfA aceptan 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.

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

Tipo de datos String	Literal de cadena	Función
WCHAR	L"string"	RtlStringCchPrintfW
char	"cadena"	RtlStringCchPrintfA

 

Si pszDest y pszFormat apuntan 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 RtlStringCchPrintfEx.

Ejemplos

En el ejemplo siguiente se muestra un uso sencillo de RtlStringCchPrintfW con cuatro argumentos.

WCHAR pszDest[30]; 
size_t cchDest = 30;

LPCWSTR pszFormat = L"%s %d + %d = %d.";
WCHAR* pszTxt = L"The answer is";

NTSTATUS status = 
    RtlStringCchPrintfW(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

La cadena resultante es "La respuesta es 1 + 2 = 3". Se encuentra en el búfer en pszDest.

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

Consulte también

RtlStringCbPrintf

RtlStringCchPrintfEx

RtlStringCchVPrintf