Función StringCbPrintfA (strsafe.h)
Escribe datos con formato en la cadena especificada. 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.
StringCbPrintf es un reemplazo de las siguientes funciones:
Sintaxis
STRSAFEAPI StringCbPrintfA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCSTR pszFormat,
...
);
Parámetros
[out] pszDest
Tipo: LPSTR
El búfer de destino, que recibe la cadena con formato terminada en null creada a partir de pszFormat y sus argumentos.
[in] cbDest
Tipo: size_t
Tamaño del búfer de destino, en bytes. Este valor debe ser lo suficientemente grande para dar cabida a la cadena con formato final más el carácter nulo de terminación. El número máximo de bytes permitido es STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszFormat
Tipo: LPCSTR
Cadena de formato. Esta cadena debe terminar en null. Para obtener más información, vea Sintaxis de especificación de formato.
...
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 cbDest es 0 o mayor que STRSAFE_MAX_CCH * sizeof(TCHAR).
|
|
Error en la operación de copia debido a un espacio de búfer insuficiente. El búfer de destino contiene 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
En comparación con las funciones que reemplaza, StringCbPrintf proporciona un 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. StringCbPrintf siempre termina en null un búfer de destino distinto de cero.
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. Consulte StringCbPrintfEx si necesita el control de valores de puntero de cadena NULL.
StringCbPrintf 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.
| String (Tipo de datos) | Literal de cadena | Función |
|---|---|---|
| char | "cadena" | StringCbPrintfA |
| TCHAR | TEXT("string") | StringCbPrintf |
| WCHAR | L"string" | StringCbPrintfW |
Ejemplos
En el ejemplo siguiente se muestra un uso básico de StringCbPrintf, con cuatro argumentos.
int const arraysize = 30;
TCHAR pszDest[arraysize];
size_t cbDest = arraysize * sizeof(TCHAR);
LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");
HRESULT hr = StringCbPrintf(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);
// The resultant string at pszDest is "The answer is 1 + 2 = 3."
Nota
El encabezado strsafe.h define StringCbPrintf 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