Función RtlStringCchPrintfExA (ntstrsafe.h)
Las funciones RtlStringCchPrintfExW y RtlStringCchPrintfExA crean una cadena de texto con recuento de caracteres, con formato basado en la información de formato proporcionada.
Sintaxis
NTSTRSAFEDDI RtlStringCchPrintfExA(
[out, optional] NTSTRSAFE_PSTR pszDest,
[in] size_t cchDest,
[out, optional] NTSTRSAFE_PSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags,
[in] NTSTRSAFE_PCSTR pszFormat,
...
);
Parámetros
[out, optional] 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. El puntero pszDest 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 distinto de NULL , 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 distinto de NULL , la función carga la dirección con el número de caracteres no utilizados en el búfer al que apunta pszDest, incluido 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 siguiente manera:
[in] pszFormat
Puntero a una cadena de texto terminada en null que contiene directivas de formato con estilo printf. El puntero pszFormat puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.
...
Lista opcional 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 |
---|---|
|
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. |
|
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 creada. |
|
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:
|
Comentarios
Se debe usar RtlStringCchPrintfExW y RtlStringCchPrintfExA en lugar de las siguientes funciones:
- sprintf
- swprintf
- _snprintf
- _snwprintf
RtlStringCchPrintfExW y RtlStringCchPrintfExA agregan a la funcionalidad de RtlStringCchPrintf 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.
Use RtlStringCchPrintfExW para controlar cadenas Unicode y RtlStringCchPrintfExA 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" | RtlStringCchPrintfExW |
char | "cadena" | RtlStringCchPrintfExA |
Si pszDest y pszFormat apuntan a cadenas superpuestas, o cualquier cadena de argumento se superpone, el comportamiento de la función no está definido.
Ni pszSrc ni pszDest pueden ser NULL a menos que se establezca la marca STRSAFE_IGNORE_NULLS, en cuyo caso o ambos pueden ser NULL. Si pszDest es NULL, pszSrc 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 en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows. |
Plataforma de destino | Escritorio |
Encabezado | ntstrsafe.h (incluya Ntstrsafe.h) |
Library | Ntstrsafe.lib |
IRQL | PASSIVE_LEVEL |
Consulte también
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de