función StringCbPrintf_lW (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.

StringCbPrintf_l es similar a StringCbPrintf , pero incluye un parámetro para la información de configuración regional.

Sintaxis

STRSAFEAPI StringCbPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cbDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]  _locale_t                                       locale,
        ...                                             
);

Parámetros

[out] pszDest

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

[in] cbDest

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

Cadena de formato. Esta cadena debe terminar en null. Para obtener más información, vea Sintaxis de especificación de formato.

[in] locale

Objeto de configuración regional. Para obtener más información, consulte _create_locale.

...

Argumentos que se van a insertar en la cadena pszFormat .

Valor devuelto

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.

Comentarios

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 StringCbPrintf_lEx si necesita el control de valores de puntero de cadena null.

Para usar esta función, debe definir la siguiente macro en el archivo de encabezado, antes de incluir StrSafe.h.

#define STRSAFE_LOCALE_FUNCTIONS

Nota

El encabezado strsafe.h define StringCbPrintf_l 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 Vista [aplicaciones de escritorio | aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2008 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino Windows
Encabezado strsafe.h