Función StringCbVPrintfA (strsafe.h)

Artículo
11/20/2024

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.

StringCbVPrintf es un reemplazo de las siguientes funciones:

Sintaxis

STRSAFEAPI StringCbVPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
  [in]  va_list        argList
);

Parámetros

[out] pszDest

Tipo: LPTSTR de

El búfer de destino, que recibe la cadena con formato terminada en NULL creada a partir de pszFormat y argList.

[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: LPCTSTR de

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

StringCbVPrintf 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. StringCbVPrintf siempre finaliza un búfer de destino que no es de longitud 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, pszFormato las cadenas de argumento se superponen.

Ni pszFormat ni pszDest deben ser NULL. Consulte StringCbVPrintfEx si necesita el control de valores de puntero de cadena NULL.

StringCbVPrintf se pueden 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.

Tipo de datos de cadena	Literal de cadena	Función
char	"string"	StringCbVPrintfA
TCHAR	TEXT("string")	StringCbVPrintf
WCHAR	L"string"	StringCbVPrintfW

Nota

El encabezado strsafe.h define StringCbVPrintf 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

StringCbPrintf

StringCbVPrintfEx

StringCchVPrintf

Compartir a través de