Função VarTokenizeFormatString (oleauto.h)

Analisa a cadeia de caracteres de formato real em uma série de tokens que podem ser usados para formatar variantes usando VarFormatFromTokens.

Sintaxe

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

A cadeia de caracteres de formato. Por exemplo, "mm-dd-yy".

[in, out] rgbTok

O buffer de token de destino.

[in] cbTok

O tamanho do buffer de token de destino.

[in] iFirstDay

Primeiro dia da semana.

Valor	Significado
0	O padrão do sistema
1	Monday
2	Terça-feira
3	Quarta-feira
4	Quinta-feira
5	Friday
6	Sábado
7	Sunday

[in] iFirstWeek

Primeira semana do ano.

Valor	Significado
0	O padrão do sistema.
1	A primeira semana contém 1º de janeiro.
2	A metade maior (quatro dias) da primeira semana está no ano atual.
3	A primeira semana tem sete dias.

[in] lcid

A localidade na qual interpretar a cadeia de caracteres de formato.

[in, optional] pcbActual

Aponta para o inteiro que é definido como o primeiro token gerado. Este parâmetro pode ser NULL.

Retornar valor

Essa função pode retornar um desses valores.

Código de retorno	Descrição
S_OK	Êxito.
E_INVALIDARG	Um ou mais argumentos não são válidos.
DISP_E_BUFFERTOOSMALL	O buffer de token de destino é muito pequeno.

Comentários

Analisar a cadeia de caracteres de formato uma vez e usá-la repetidamente geralmente é mais rápido do que chamar VarFormat repetidamente, pois a última rotina chama VarTokenizeFormatString para cada chamada.

A localidade que você passa controla como a cadeia de caracteres de formato é interpretada, não a aparência da saída real de VarFormatFromTokens .

Requisitos

Requisito	Valor
Plataforma de Destino	Windows
Cabeçalho	oleauto.h
Biblioteca	OleAut32.lib
DLL	OleAut32.dll