Strings.FormatDateTime(DateTime, DateFormat) Método

  • Referência

Definição

Namespace:
Microsoft.VisualBasic
Assembly:
Microsoft.VisualBasic.Core.dll
Assembly:
Microsoft.VisualBasic.dll
Origem:
Strings.vb
Origem:
Strings.vb
Origem:
Strings.vb

Retorna uma expressão de cadeia de caracteres que representa um valor de data/hora.

public static string FormatDateTime (DateTime Expression, Microsoft.VisualBasic.DateFormat NamedFormat = Microsoft.VisualBasic.DateFormat.GeneralDate);
static member FormatDateTime : DateTime * Microsoft.VisualBasic.DateFormat -> string
Public Function FormatDateTime (Expression As DateTime, Optional NamedFormat As DateFormat = Microsoft.VisualBasic.DateFormat.GeneralDate) As String

Parâmetros

Expression
DateTime

Obrigatórios. Expressão Date a ser formatada.

NamedFormat
DateFormat

Opcional. Valor numérico que indica o formato de data/hora usado. Se omitido, DateFormat.GeneralDate será usado.

Retornos

String

Uma expressão de cadeia de caracteres que representa um valor de data/hora.

Exceções

ArgumentException

A configuração NamedFormat não é válida.

Exemplos

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

' 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)

Comentários

O Date tipo de dados sempre contém informações de data e hora. Para fins de conversão de tipo, o Visual Basic considera 1/1/1 (1º de janeiro do ano 1) como um valor neutro para a data e 00:00:00 (meia-noite) como um valor neutro para a hora. Se você formatar um Date valor como uma cadeia de caracteres de data/hora, FormatDateTime não incluirá valores neutros na cadeia de caracteres resultante. Por exemplo, se você converter #1/1/0001 9:30:00# em uma cadeia de caracteres, o resultado será "9:30:00 AM"; as informações de data são suprimidas. No entanto, as informações de data ainda estão presentes no valor original Date e podem ser recuperadas com funções como DatePart.

Observação

Se você passar o Expression argumento como um String literal, FormatDateTime o interpretará de acordo com a CurrentCulture configuração do aplicativo. No entanto, se você passá-lo como um Date literal, use o formato #mm/dd/aaaa#, pois FormatDateTime sempre interpreta um Date literal de acordo com a cultura em inglês (EUA). Isso é necessário porque, se um aplicativo for desenvolvido e codificado usando Date literais de uma cultura, mas for executado em uma plataforma com uma cultura diferente, os Date literais poderão ser analisados incorretamente.

O NamedFormat argumento tem as configurações a seguir.

Constante Descrição
DateFormat.GeneralDate Exibir uma data e/ou hora. Exibir uma parte de data como uma data curta. Se houver uma parte de tempo, exiba-a por muito tempo. Se estiverem presentes, ambas as partes serão exibidas.
DateFormat.LongDate Exiba uma data usando o formato de data longa especificado nas configurações regionais do computador.
DateFormat.ShortDate Exiba uma data usando o formato de data curto especificado nas configurações regionais do computador.
DateFormat.LongTime Exiba uma hora usando o formato de hora especificado nas configurações regionais do computador.
DateFormat.ShortTime Exibe uma hora usando o formato de 24 horas (hh:mm).

Aplica-se a

Confira também