Función RtlStringCbPrintfExW (ntstrsafe.h)

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

Sintaxis

NTSTRSAFEDDI RtlStringCbPrintfExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags,
  [in, optional]  NTSTRSAFE_PCWSTR 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] 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).

Si pszDest es NULL, cbDest 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] pcbRemaining

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 bytes no usados a los 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 siguiente manera:

Valor	Significado
STRSAFE_FILL_BEHIND_NULL	Si set y la función se realiza 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 o pszSrc, o ambos, pueden ser NULL. Los punteros pszSrcNULL se tratan como cadenas vacías (TEXT("")), que se pueden copiar. Los punteros pszDestNULL no pueden recibir cadenas no vacías.
STRSAFE_FILL_ON_FAILURE	Si se establece y se produce un error en la función, el byte bajo de dwFlags se usa para rellenar todo el búfer de destino y el búfer termina en null. Esta operación sobrescribe cualquier contenido de 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 cualquier contenido de búfer preexistente.
STRSAFE_NO_TRUNCATION	Si 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 directivas de formato con estilo printf. El puntero pszFormat puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

...

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 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. 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.
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: Se especificó una marca no válida. El valor de cbDest 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 era NULL, pero el tamaño del búfer no era cero. El puntero del búfer de destino era NULL o su longitud era cero, pero había una cadena de origen de longitud distinta de cero.

Comentarios

Se debe usar RtlStringCbPrintfExW y RtlStringCbPrintfExA en lugar de las siguientes funciones:

• sprintf
• swprintf
• _snprintf
• _snwprintf

Todas estas funciones aceptan una cadena de formato y una lista de argumentos, las interpretan y crean una cadena con formato. El tamaño, en bytes, del búfer de destino se proporciona a RtlStringCbPrintfExW y RtlStringCbPrintfExA para asegurarse de que no escriben más allá del final del búfer.

RtlStringCbPrintfExW y RtlStringCbPrintfExA agregan a la funcionalidad de RtlStringCbPrintf devolviendo un puntero al final de la cadena de destino, así como el número de bytes que quedan sin usar en esa cadena. Las marcas se pueden pasar a la función para un control adicional.

Use RtlStringCbPrintfExW para controlar cadenas Unicode y RtlStringCbPrintfExA 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"	RtlStringCbPrintfExW
char	"cadena"	RtlStringCbPrintfExA

 

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 a menos que se establezca la marca de STRSAFE_IGNORE_NULLS, en cuyo caso o ambos pueden ser NULL. Si pszDest es NULL, pszFormat 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 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

RtlStringCbVPrintfEx

RtlStringCchPrintf

RtlStringCchPrintfEx