Función StringCchVPrintfExA (strsafe.h)
Escribe datos con formato en la cadena especificada mediante un puntero a una lista de argumentos. El tamaño del búfer de destino se proporciona a la función para asegurarse de que no escribe más allá del final de este búfer.
StringCchVPrintfEx agrega a la funcionalidad de StringCchVPrintf devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que quedan sin usar en esa cadena. También se pueden pasar marcas a la función para un control adicional.
StringCchVPrintfEx es un reemplazo de las funciones siguientes:
Sintaxis
STRSAFEAPI StringCchVPrintfExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags,
[in] STRSAFE_LPCSTR pszFormat,
[in] va_list argList
);
Parámetros
[out] pszDest
Tipo: LPTSTR
El búfer de destino, que recibe la cadena con formato terminada en null creada a partir de pszFormat y argList.
[in] cchDest
Tipo: size_t
Tamaño del búfer de destino, en caracteres. Este valor debe ser lo suficientemente grande como para dar cabida a la cadena con formato final más 1 para tener en cuenta el carácter nulo de terminación. El número máximo de caracteres permitido es STRSAFE_MAX_CCH.
[out, optional] ppszDestEnd
Tipo: LPTSTR*
Dirección de un puntero al final de pszDest. Si ppszDestEnd no es NULL y los datos se copian en el búfer de destino, esto apunta al carácter nulo de terminación al final de la cadena.
[out, optional] pcchRemaining
Tipo: size_t*
Número de caracteres sin usar en pszDest, incluido el carácter nulo de terminación. Si pcchRemaining es NULL, el recuento no se mantiene ni se devuelve.
[in] dwFlags
Tipo: DWORD
Uno o varios de los valores siguientes.
[in] pszFormat
Tipo: LPCTSTR
Cadena de formato. Esta cadena debe terminar en null. Para obtener más información, vea Sintaxis de especificación de formato.
[in] argList
Tipo: va_list
Argumentos que se van a insertar en la cadena pszFormat .
Valor devuelto
Tipo: HRESULT
Esta función puede devolver uno de los valores siguientes. Se recomienda encarecidamente usar las macros SUCCEEDED y FAILED para probar el valor devuelto de esta función.
| Código devuelto | Descripción |
|---|---|
|
Había suficiente espacio para que el resultado se copie en pszDest sin truncamiento y el búfer termina en null. |
|
El valor de cchDest es 0 o mayor que STRSAFE_MAX_CCH, o el búfer de destino ya está lleno. |
|
Error en la operación de copia debido a un espacio de búfer insuficiente. Según el valor de dwFlags, el búfer de destino puede contener una versión truncada terminada en null del resultado previsto. En situaciones en las que el truncamiento es aceptable, es posible que esto no se vea necesariamente como una condición de error. |
Tenga en cuenta que esta función devuelve un valor HRESULT , a diferencia de las funciones que reemplaza.
Comentarios
StringCchVPrintfEx proporciona procesamiento adicional para el control adecuado del búfer en el código. El control deficiente del búfer está implicado en muchos problemas de seguridad que implican saturaciones del búfer. StringCchVPrintfEx siempre termina en null un búfer de destino distinto de cero.
Para obtener más información sobre va_lists, consulte las convenciones definidas en Stdarg.h.
El comportamiento no está definido si las cadenas a las que apunta pszDest, pszFormat o cualquier cadena de argumento se superponen.
Ni pszFormat ni pszDest deben ser NULL a menos que se especifique la marca STRSAFE_IGNORE_NULLS , en cuyo caso ambos pueden ser NULL. Sin embargo, es posible que todavía se devuelva un error debido a un espacio insuficiente aunque se omitan los valores NULL .
StringCchVPrintfEx se puede usar en su forma genérica o en sus formularios más específicos. El tipo de datos de la cadena determina la forma de esta función que debe usar, como se muestra en la tabla siguiente.
| String (Tipo de datos) | Literal de cadena | Función |
|---|---|---|
| char | "cadena" | StringCchVPrintfExA |
| TCHAR | TEXT("string") | StringCchVPrintfEx |
| WCHAR | L"string" | StringCchVPrintfExW |
Nota:
El encabezado strsafe.h define StringCchVPrintfEx como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.
Requisitos
| Cliente mínimo compatible | Windows XP con SP2 [aplicaciones de escritorio | Aplicaciones para UWP] |
| Servidor mínimo compatible | Windows Server 2003 con SP1 [aplicaciones de escritorio | Aplicaciones para UWP] |
| Plataforma de destino | Windows |
| Encabezado | strsafe.h |
Consulte también
Referencia