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

• vsprintf, vswprintf, _vstprintf
• vsnprintf, _vsnwprintf, _vsntprintf
• wvsprintf
• wvnsprintf

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 de

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 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 esNULL y los datos se copian en el búfer de destino, 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 conserva ni devuelve.

[in] dwFlags

Tipo: DWORD de

Uno o varios de los siguientes valores.

Valor	Significado
STRSAFE_FILL_BEHIND_NULL 0x00000200	Si la función se ejecuta correctamente, se usa el byte bajo de dwFlags (0) para rellenar la parte no inicializada de pszDest después del carácter nulo de terminación.
STRSAFE_IGNORE_NULLS 0x00000100	Trate null punteros de cadena como cadenas vacías (TEXT("")).
STRSAFE_FILL_ON_FAILURE 0x00000400	Si se produce un error en la función, se usa el byte bajo de dwFlags (0) para rellenar todo el búfer de pszDest y el búfer termina en null. En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER, se sobrescribe cualquier cadena truncada devuelta.
STRSAFE_NULL_ON_FAILURE 0x00000800	Si se produce un error en la función, pszDest se establece en una cadena vacía (TEXT("")). En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER, se sobrescribe cualquier cadena truncada.
STRSAFE_NO_TRUNCATION 0x00001000	Como en el caso de STRSAFE_NULL_ON_FAILURE, si se produce un error en la función, pszDest se establece en una cadena vacía (TEXT("")). En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER, se sobrescribe cualquier cadena truncada.

[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 cchDest es 0 o mayor que STRSAFE_MAX_CCHo el búfer de destino ya está lleno.
STRSAFE_E_INSUFFICIENT_BUFFER	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 y 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

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 de búfer. StringCchVPrintfEx siempre finaliza un búfer de destino de longitud no 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 a menos que se especifique la marca STRSAFE_IGNORE_NULLS, en cuyo caso ambos pueden ser NULL. Sin embargo, es posible que se devuelva un error debido a un espacio insuficiente aunque se omitan 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.

Tipo de datos de cadena	Literal de cadena	Función
char	"string"	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 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

StringCbVPrintfEx

stringCchPrintfEx

StringCchVPrintf