Home
DB Doc online help Prev Page Prev Page
Introduction
About DB Doc
Version history
Supported database engines
Prerequisites
Contact us
Using DB Doc
The Home page
Creating a project
Project settings
Database
Schemas
Comments
Create docs
The script editor
Useful shortcuts
Scripting
Data types
Script structure
Language basics
Debugging
Global variables
Class reference
TDocSettings
Properties
ChmFileName
ChmFolder
ChmProjectFileName
ChmTocFileName
DocumentType
HtmlFolder
HtmlIndexFileName
TemplateFolder
UserDefinedValue1
UserDefinedValue2
UserDefinedValue3
PostgreSQL class reference
TServer
Methods
Database
DatabaseCount
Name
ServerSetting
SettingCount
Version
TServerSetting
Methods
Category
Context
Name
Unit
Value
VarType
TDatabase
Methods
AllowConnections
Comment
Encoding
IsTemplate
Name
Owner
Schema
SchemaCount
TDBObject
Methods
Comment
Name
OID
Owner
Schema
TSchema
Methods
ACL
DBFunction
DBFunctionCount
Domain
DomainCount
Sequence
SequenceCount
Skip
Table
TableCount
View
ViewCount
TTable
Methods
CheckConstraint
CheckConstraintCount
Column
ColumnCount
EstimatedRows
ForeignKey
ForeignKeyCount
Index
IndexCount
PrimaryKeys
Tablespace
Trigger
TriggerCount
UniqueConstraint
UniqueConstraintCount
TColumn
Methods
AllowNull
CheckConstraint
ColumnType
Comment
DefaultValue
Domain
IsPrimaryKey
IsUnique
Length
Name
Sequence
Table
TForeignKey
Methods
DeleteType
Keys
MatchType
Name
ReferenceKeys
ReferenceTable
Table
UpdateType
TIndex
Methods
Definition
IsClustered
IsPrimary
IsUnique
Name
TConstraint
Methods
Columns
Comment
Name
TUniqueConstraint
TCheckConstraint
Methods
Definition
TTrigger
Methods
TriggerFunction
TSequence
Methods
ACL
CacheValue
Called
Column
ColumnCount
CurrentValue
Cycled
Increment
MaxValue
MinValue
TDomain
Methods
AllowNull
BaseType
Column
ColumnCount
ConstraintName
DefaultValue
Definition
TView
Methods
ACL
ColumnCount
Definition
TFunction
Methods
ArgCount
Arguments
Definition
IsStrict
LangName
ReturnsSet
ReturnType
SignatureArguments
Volatility
TTriggerFunction
TTextFile
Properties
UseUTF8
Methods
CurrentLineIndex
InsertLine
SaveToDisk
SaveToDiskAndList
WriteText
WriteLine
TChmProjectFile
Methods
AddFile
AddFilesFromList
SetOption
TChmTocFile
Methods
BuildTOCFromFile
Support functions
String functions
Date and time functions
Date-Time format strings
File functions
Formatting functions
HTMLEncode
HTMLFormatSQL
Command line interface

Date-Time format strings

Date/Time format strings control the formatting of dates and times. They specify the formatting of date-time values when they are converted to strings (such as the FormatDateTime function).

Date Time format strings are composed from specifiers that represent values to be inserted into the formatted string. Some specifiers (such as "d"), simply format numbers or strings. Other specifiers (such as "/") refer to locale-specific strings from global variables.

In the following table, specifiers are given in lower case. Case is ignored in formats, except for the "am/pm" and "a/p" specifiers.

Specifier   
Description
c
Displays the date using the format given by the ShortDateFormat global variable, followed by the time using the format given by the LongTimeFormat global variable. The time is not displayed if the date-time value indicates midnight precisely.

d
Displays the day as a number without a leading zero (1-31).

dd
Displays the day as a number with a leading zero (01-31).

ddd
Displays the day as an abbreviation (Sun-Sat) using the strings given by the ShortDayNames global variable.

dddd
Displays the day as a full name (Sunday-Saturday) using the strings given by the LongDayNames global variable.

ddddd
Displays the date using the format given by the ShortDateFormat global variable.

dddddd
Displays the date using the format given by the LongDateFormat global variable.

e
Displays the year in the current period/era as a number without a leading zero (Japanese, Korean and Taiwanese locales only).

ee
Displays the year in the current period/era as a number with a leading zero (Japanese, Korean and Taiwanese locales only).

g
Displays the period/era as an abbreviation (Japanese and Taiwanese locales only).

gg
Displays the period/era as a full name. (Japanese and Taiwanese locales only).

m
Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.

mm
Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.

mmm
Displays the month as an abbreviation (Jan-Dec) using the strings given by the ShortMonthNames global variable.

mmmm
Displays the month as a full name (January-December) using the strings given by the LongMonthNames global variable.

yy
Displays the year as a two-digit number (00-99).

yyyy
Displays the year as a four-digit number (0000-9999).

h
Displays the hour without a leading zero (0-23).

hh
Displays the hour with a leading zero (00-23).

n
Displays the minute without a leading zero (0-59).

nn
Displays the minute with a leading zero (00-59).

s
Displays the second without a leading zero (0-59).

ss
Displays the second with a leading zero (00-59).

z
Displays the millisecond without a leading zero (0-999).

zzz
Displays the millisecond with a leading zero (000-999).

t
Displays the time using the format given by the ShortTimeFormat global variable.

tt
Displays the time using the format given by the LongTimeFormat global variable.

am/pm
Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.

a/p
Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.

ampm   
Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the TimeAMString global variable for any hour before noon, and the contents of the TimePMString global variable for any hour after noon.

/   
Displays the date separator character given by the DateSeparator global variable.

:   
Displays the time separator character given by the TimeSeparator global variable.

'xx'/"xx"   
Characters enclosed in single or double quotes are displayed as-is, and do not affect formatting.