Función StringCchPrintfExW (strsafe.h)

  • Artículo

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 después del final de este búfer.

StringCchPrintfEx agrega a la funcionalidad de StringCchPrintf devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que quedan sin usar en esa cadena. Las marcas también se pueden pasar a la función para un control adicional.

StringCchPrintfEx es un reemplazo de las siguientes funciones:

Sintaxis

STRSAFEAPI StringCchPrintfExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags,
  [in]            STRSAFE_LPCWSTR pszFormat,
                  ...             
);

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 sus argumentos.

[in] cchDest

Tipo: size_t

Tamaño del búfer de destino, en caracteres. Este valor debe ser 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 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.

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 punteros de cadena NULL como cadenas vacías (TEXT("")).
STRSAFE_FILL_ON_FAILURE
0x00000400
 Si se produce un error en la función, el byte bajo de dwFlags (0) se usa para rellenar todo el búfer 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

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 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_CCH, o 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 HRESULT , a diferencia de las funciones que reemplaza.

Comentarios

En comparación con las funciones que reemplaza, StringCchPrintfEx 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. StringCchPrintfEx siempre termina en null un búfer de destino que no es de longitud 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 a menos que se especifique la marca de 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 .

StringCchPrintfEx 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" StringCchPrintfExA
TCHAR TEXT("string") StringCchPrintfEx
WCHAR L"string" StringCchPrintfExW
 

Nota

El encabezado strsafe.h define StringCchPrintfEx 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

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

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx