Función StringCbPrintfA (strsafe.h)

Artículo
11/20/2024

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 funciones siguientes:

Sintaxis

STRSAFEAPI StringCbPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

Parámetros

[out] pszDest

Tipo: LPSTR de

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 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 de

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 de pszFormat.

Valor devuelto

Tipo: HRESULT

Esta función puede devolver uno de los siguientes valores. Se recomienda encarecidamente usar las macros SUCCEEDED y FAILED para probar el valor devuelto de esta función.

Código devuelto	Descripción
S_OK	Había suficiente espacio para copiar el resultado en pszDest sin truncamiento y el búfer está terminado en null.
STRSAFE_E_INVALID_PARAMETER	El valor de cbDest es 0 o mayor que `STRSAFE_MAX_CCH * sizeof(TCHAR)`.
STRSAFE_E_INSUFFICIENT_BUFFER	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 de HRESULT, a diferencia de las funciones que reemplaza.

Observaciones

En comparación con las funciones que reemplaza, stringCbPrintf 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 de búfer. StringCbPrintf siempre finaliza un búfer de destino de longitud cero.

El comportamiento no está definido si las cadenas a las que apunta pszDest, pszFormato las cadenas 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 se debe usar.

Tipo de datos de cadena	Literal de cadena	Función
char	"string"	StringCbPrintfA
TCHAR	TEXT("string")	StringCbPrintf
WCHAR	L"string"	StringCbPrintfW

Ejemplos

En el ejemplo siguiente se muestra un uso básico de StringCbPrintf, mediante 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows XP con SP2 [aplicaciones de escritorio \| Aplicaciones para UWP]
servidor mínimo admitido	Windows Server 2003 con SP1 [aplicaciones de escritorio \| Aplicaciones para UWP]
de la plataforma de destino de	Windows
encabezado de	strsafe.h

Consulte también

de referencia de

StringCbPrintfEx

StringCbVPrintf

StringCchPrintf

Compartir a través de