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

  • Artigo

Formata uma cadeia de caracteres de acordo com um padrão.

Nota O uso desse método não é mais recomendado porque contêineres diferentes do Visual Basic não dão suporte a ele.
 

Sintaxe

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

Dados a serem formatados.

[in] bstrFormat

Formatar cadeia de caracteres a ser aplicada aos dados.

[in] lpBuffer

Ponteiro para o buffer de resultados.

[in] cb

Comprimento do buffer de resultado.

[in] lcid

ID da localidade.

[in] sFirstDayOfWeek

Afeta o resultado do formato 'w', FirstDayOfWeek.

Valor Significado
vbUseSystem
 Use a configuração FirstWeekday na interface do usuário do host. Se nenhum valor de host for fornecido, use o valor do sistema atual da API nls.
vbSunday
 Sunday
vbMonday
 Monday
vbTuesday
 Terça-feira
vbWednesday
 Quarta-feira
vbThursday
 Quinta-feira
vbFriday
 Friday
vbSaturday
 Sábado

[in] sFirstWeekOfYear

Afeta o resultado do formato 'ww', FirstWeekOfYear.

Valor Significado
vbUseSystem
 Use a configuração FirstWeekOfYear na interface do usuário do host. Se nenhum valor de host for fornecido, use o valor do sistema atual da API nls.
vbFirstJan1
 Comece em 1º de janeiro (padrão).
vbFirstFourDays
 Comece com a primeira semana de quatro dias.
vbFirstFullWeek
 Comece com a primeira semana completa.

[out] rcb

Número de bytes copiados para o buffer de resultados.

Valor retornado

Esse método dá suporte aos valores retornados padrão E_INVALIDARG, E_OUTOFMEMORY e E_UNEXPECTED, bem como o seguinte:

Comentários

Ao migrar um controle VBX para um controle OLE, Format substitui o VBFormat do Visual Basic, que não tem mais suporte.

Requisitos

   
Plataforma de Destino Windows
Cabeçalho vbinterf.h

Confira também

IVBFormat