Método IVBFormat::Format (vbinterf.h)

  • Artículo

Da formato a una cadena según un patrón.

Nota El uso de este método ya no se recomienda porque los contenedores distintos de Visual Basic no lo admiten.
 

Sintaxis

HRESULT Format(
  [in]  VARIANT *vData,
  [in]  BSTR    bstrFormat,
  [in]  LPVOID  lpBuffer,
  [in]  USHORT  cb,
  [in]  LONG    lcid,
  [in]  SHORT   sFirstDayOfWeek,
  [in]  USHORT  sFirstWeekOfYear,
  [out] USHORT  *rcb
);

Parámetros

[in] vData

Datos a los que se va a dar formato.

[in] bstrFormat

Cadena de formato que se va a aplicar a los datos.

[in] lpBuffer

Puntero al búfer de resultados.

[in] cb

Longitud del búfer de resultados.

[in] lcid

Id. de configuración regional.

[in] sFirstDayOfWeek

Afecta al resultado de formato "w", FirstDayOfWeek.

Value Significado
vbUseSystem
 Use la configuración FirstWeekday en la interfaz de usuario del host. Si no se proporciona ningún valor de host, use el valor actual del sistema de la API NLS.
vbSunday
 Domingo
vbMonday
 Lunes
vbTuesday
 Martes
vbWednesday
 Miércoles
vbThursday
 Jueves
vbFriday
 Viernes
vbSaturday
 Sábado

[in] sFirstWeekOfYear

Afecta al resultado de formato "ww", FirstWeekOfYear.

Valor Significado
vbUseSystem
 Use la configuración FirstWeekOfYear en la interfaz de usuario del host. Si no se proporciona ningún valor de host, use el valor actual del sistema de la API NLS.
vbFirstJan1
 Comience el 1 de enero (valor predeterminado).
vbFirstFourDays
 Comience con la primera semana de cuatro días.
vbFirstFullWeek
 Comience con la primera semana completa.

[out] rcb

Número de bytes copiados en el búfer de resultados.

Valor devuelto

Este método admite los valores devueltos estándar E_INVALIDARG, E_OUTOFMEMORY y E_UNEXPECTED, así como los siguientes:

Comentarios

Al migrar un control VBX a un control OLE, Format reemplaza el VBFormat de Visual Basic, que ya no se admite.

Requisitos

   
Plataforma de destino Windows
Encabezado vbinterf.h

Consulte también

IVBFormat