Función VarTokenizeFormatString (oleauto.h)

  • Artículo

Analiza la cadena de formato real en una serie de tokens que se pueden usar para dar formato a variantes mediante VarFormatFromTokens.

Sintaxis

HRESULT VarTokenizeFormatString(
  [in, optional] LPOLESTR pstrFormat,
  [in, out]      LPBYTE   rgbTok,
  [in]           int      cbTok,
  [in]           int      iFirstDay,
  [in]           int      iFirstWeek,
  [in]           LCID     lcid,
  [in, optional] int      *pcbActual
);

Parámetros

[in, optional] pstrFormat

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

[in, out] rgbTok

Búfer de token de destino.

[in] cbTok

Tamaño del búfer de tokens de destino.

[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 se encuentra en el año actual.
3
 La primera semana tiene siete días.

[in] lcid

Configuración regional en la que se va a interpretar la cadena de formato.

[in, optional] pcbActual

Apunta al entero que se establece en el primer token generado. Este parámetro puede ser NULL.

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.
DISP_E_BUFFERTOOSMALL
El búfer del token de destino es demasiado pequeño.

Comentarios

Analizar la cadena de formato una vez y usarla repetidamente suele ser más rápida que llamar a VarFormat repetidamente, ya que la última rutina llama a VarTokenizeFormatString para cada llamada.

La configuración regional que se pasa controla cómo se interpreta la cadena de formato, no cómo se ve la salida real de VarFormatFromTokens .

Requisitos

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