Função FormatDateTime (Visual Basic)

Artigo
08/25/2010

Retorna em uma cadeia de caracteres uma expressão representando o valor de data/hora.

Function FormatDateTime(
   ByVal Expression As DateTime,
   Optional ByVal NamedFormat As DateFormat = DateFormat.GeneralDate
) As String

Parâmetros

Expression
Obrigatório.Date expressão a ser formatado.
NamedFormat
Opcional.Valor numérico que indica o formato data/hora utilizado.Se omitido, DateFormat.GeneralDate é utilizado.

Configurações

O argumento NamedFormat tem as seguintes configurações.

Constante	Descrição
DateFormat.GeneralDate	Exibir uma data e/ou tempo.Exibir uma parte da data como uma data abreviada.Se houver uma hora parcial, mostrá-la como uma hora longa.Se estiverem presentes, exibir as duas partes.
DateFormat.LongDate	Exibir uma data usando o formato de data longo especificado nas definições regionais do computador.
DateFormat.ShortDate	Exibir uma data usando o formato de data abreviada especificado nas definições regionais do computador.
DateFormat.LongTime	Exibir uma hora usando o formato de hora especificado nas definições regionais do computador.
DateFormat.ShortTime	Exibir uma hora no formato de 24 horas (hh:mm).

Exceções

Tipo de exceção	Número de erro	Condição
ArgumentException	5	Configuração NamedFormat não é válida.

Ver a coluna " número de erro " se você estiver atualizando aplicativos Visual Basic 6.0 que usam manipulação de erros não estruturada.(Você pode comparar o número do erro com a Propriedade do Número (Erro de objeto).) Entretanto, quando for possivel, você pode considerar substituir tal controle de erro por Visão Geral sobre a Manipulação Estruturada de Exceções para o Visual Basic.

Comentários

O tipo de dado Date sempre contém informações para ambos data e hora.Para fins de conversão de tipos, Visual Basic considera 1/1/1 (1 de Janeiro do ano 1) como sendo um valor neutro para a data e 00:00:00 (meia-noite) como sendo um valor neutro para a hora.Se você formatar o valor Date como uma cadeia de caracteres data/hora, FormatDateTime não inclui valores neutros na cadeia de caracteres resultantes.Por exemplo, se você converte #1/1/0001 9:30:00# em uma cadeia de caracteres, o resultado é "9:30:00 AM"; a informação da data é suprimida.No entanto, a informação de data ainda está presente no valor Date original e pode ser recuperada com funções do tipo DatePart.

Observação:
Se você passar o Expression argumento sistema autônomo um String literal, FormatDateTime interpreta acordo com o CurrentCulture configuração do seu aplicativo. No entanto, se você passar isto como uma Date literal, use o formato #mm/dd/yyyy", porque FormatDateTime sempre interpreta o literal Date de acordo com a cultura inglesa (US).Isto é necessário porque, se um aplicativo é desenvolvido e codificado usando literais Date de uma cultura, mas é, então, executado em uma plataforma com diferente cultura, os literais Date podem ser interpretados incorretamente.

Se você passar o Expression argumento sistema autônomo um String literal, FormatDateTime interpreta acordo com o CurrentCulture configuração do seu aplicativo. No entanto, se você passar isto como uma Date literal, use o formato #mm/dd/yyyy", porque FormatDateTime sempre interpreta o literal Date de acordo com a cultura inglesa (US).Isto é necessário porque, se um aplicativo é desenvolvido e codificado usando literais Date de uma cultura, mas é, então, executado em uma plataforma com diferente cultura, os literais Date podem ser interpretados incorretamente.

Exemplo

Este exemplo demonstra o uso da função FormatDateTime.

' English (US) format.
Dim TestDate As DateTime = #3/12/1999#

' FormatDateTime returns "Friday, March 12, 1999".
' The time information is neutral (00:00:00) and therefore suppressed.
Dim TestString As String = FormatDateTime(TestDate, DateFormat.LongDate)