FormatDateTime (Función, Visual Basic)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve una expresión de cadena que representa un valor de fecha u hora.

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

Parámetros

Expression
Requerido. Expresión de tipo Date a la que se va a dar formato.
NamedFormat
Opcional. Valor numérico que indica el formato de fecha u hora utilizado. Si se omite, se utiliza DateFormat.GeneralDate.

Valores

El argumento NamedFormat tiene los siguientes valores.

Constante	Descripción
DateFormat.GeneralDate	Muestra una fecha o una hora. Muestra una parte de la fecha como una fecha corta. Si hay una parte con hora, ésta se mostrará como hora larga. De estar presentes, se mostrarán ambas partes.
DateFormat.LongDate	Muestra una fecha con el formato de fecha larga especificado en la configuración regional del equipo.
DateFormat.ShortDate	Muestra una fecha con el formato de fecha corta especificado en la configuración regional del equipo.
DateFormat.LongTime	Muestra una hora con el formato de hora especificado en la configuración regional del equipo.
DateFormat.ShortTime	Muestra una hora con el formato de 24 horas (hh:mm).

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException	5	El valor de NamedFormat no es válido.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, se debe considerar la sustitución de dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

El tipo de datos Date siempre contiene información de fecha y hora. Para la conversión de tipos, Visual Basic considera 1/1/1 (1 de enero del año 1) un valor neutral de fecha y 00:00:00 (medianoche) un valor neutral de hora. Si a un valor Date se le asigna el formato de cadena de fecha u hora, FormatDateTime no incluye valores neutrales en la cadena resultante. Por ejemplo, si se convierte #1/1/0001 9:30:00# en una cadena, el resultado sería "9:30:00 AM", ya que la información de fecha se omite. No obstante, la información de fecha sigue estando presente en el valor Date original y se puede recuperar mediante funciones como DatePart.

Nota:
Si transfiere el argumento Expression como un literal String, FormatDateTime lo interpreta según la configuración de CurrentCulture de su aplicación. Sin embargo, si lo transfiere como un literal Date, debería utilizar el formato #mm/dd/aaaa#, porque FormatDateTime siempre interpreta un literal Date de acuerdo con la referencia cultural de inglés (EE.UU.). Esto es necesario porque, si una aplicación se desarrolla y codifica utilizando literales Date de una referencia cultural pero se ejecuta en una plataforma de otra referencia cultural diferente, los literales Date podrían analizarse de forma incorrecta.

Si transfiere el argumento Expression como un literal String, FormatDateTime lo interpreta según la configuración de CurrentCulture de su aplicación. Sin embargo, si lo transfiere como un literal Date, debería utilizar el formato #mm/dd/aaaa#, porque FormatDateTime siempre interpreta un literal Date de acuerdo con la referencia cultural de inglés (EE.UU.). Esto es necesario porque, si una aplicación se desarrolla y codifica utilizando literales Date de una referencia cultural pero se ejecuta en una plataforma de otra referencia cultural diferente, los literales Date podrían analizarse de forma incorrecta.

Ejemplo

En este ejemplo se muestra el uso de la función 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)