Share via

Función VarFormat (oleauto.h)

  • Artículo

Da formato a una variante en forma de cadena mediante el análisis de una cadena de formato.

Sintaxis

HRESULT VarFormat(
  [in]           LPVARIANT pvarIn,
  [in, optional] LPOLESTR  pstrFormat,
  [in]           int       iFirstDay,
  [in]           int       iFirstWeek,
  [in]           ULONG     dwFlags,
  [out]          BSTR      *pbstrOut
);

Parámetros

[in] pvarIn

Variante.

[in, optional] pstrFormat

Cadena de formato. Por ejemplo, "mm-dd-aaaa".

[in] iFirstDay

Primer día de la semana.

Valor Significado
0
 Valor predeterminado del sistema
1
 Lunes
2
 Martes
3
 Miércoles
4
 Jueves
5
 Viernes
6
 Sábado
7
 Domingo

[in] iFirstWeek

Primera semana del año.

Valor Significado
0
 Valor predeterminado del sistema.
1
 La primera semana contiene el 1 de enero.
2
 La mitad mayor (cuatro días) de la primera semana está en el año actual.
3
 La primera semana tiene siete días.

[in] dwFlags

Marcas que controlan el proceso de formato. Las únicas marcas que se pueden establecer son VAR_CALENDAR_HIJRI o VAR_FORMAT_NOSUBSTITUTE.

[out] pbstrOut

Cadena con formato que representa la variante.

Valor devuelto

Esta función puede devolver uno de estos valores.

Código devuelto Descripción
S_OK
 Correcto.
E_INVALIDARG
 Uno o varios de los argumentos no son válidos.

Comentarios

Esta función usa la configuración regional predeterminada del usuario al llamar a VarTokenizeFormatString y VarFormatFromTokens.

Requisitos

Requisito Value
Plataforma de destino Windows
Encabezado oleauto.h
Library OleAut32.lib
Archivo DLL OleAut32.dll

Consulte también

Rutinas de formato

VarFormatFromTokens

VarTokenizeFormatString