Compartilhar via


Função VarFormat (oleauto.h)

Formata uma variante no formulário de cadeia de caracteres analisando uma cadeia de caracteres de formato.

Sintaxe

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

A variante.

[in, optional] pstrFormat

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

[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] dwFlags

Sinalizadores que controlam o processo de formatação. Os únicos sinalizadores que podem ser definidos são VAR_CALENDAR_HIJRI ou VAR_FORMAT_NOSUBSTITUTE.

[out] pbstrOut

A cadeia de caracteres formatada que representa a variante.

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.

Comentários

Essa função usa a localidade padrão do usuário ao chamar VarTokenizeFormatString e VarFormatFromTokens.

Requisitos

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

Confira também

Rotinas de formatação

VarFormatFromTokens

VarTokenizeFormatString