Compartir a través de

función StringCchVPrintf_lExA (strsafe.h)

  • Artículo

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

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

Sintaxis

STRSAFEAPI StringCchVPrintf_lExA(
  [out]           STRSAFE_LPSTR                                  pszDest,
  [in]            size_t                                         cchDest,
  [out]           STRSAFE_LPSTR                                  *ppszDestEnd,
  [out, optional] size_t                                         *pcchRemaining,
  [in]            DWORD                                          dwFlags,
  [in]            _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
  [in]            _locale_t                                      locale,
  [in]            va_list                                        argList
);

Parámetros

[out] pszDest

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

[in] cchDest

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

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

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

Uno o varios de los valores siguientes.

Value 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

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.

[in] argList

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

Comentarios

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

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

   
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