GetDateTimeValue

Description

Returns the value of a PBDOM_ATTRIBUTE object as type DateTime.

Syntax

pbdom_attribute_name.GetDateTimeValue(string strDateFormat, string strTimeFormat)

Argument

Description

pbdom_attribute_name

The name of the PBDOM_ATTRIBUTE

strDateFormat

The date format for the return value, for example, MM:DD:YYYY

strTimeFormat

The time format for the return value, for example, HH:MM:SS


The value of the strDateFormat parameter can use slashes or colons as delimiters. The following table illustrates characters that have special meaning in strDateFormat.

Character

Meaning

Example

D

Day number with no leading zero

5

DD

Day number with leading zero, if applicable

05

M

Month number with no leading zero

5

MM

Month number with leading zero, if applicable

05

YY

Two-digit year number

05

YYYY

Four-digit year number

2005


The value of the strTimeFormat parameter can use slashes or colons as delimiters. The following table illustrates characters that have special meaning in strTimeFormat.

Character

Meaning

Example

H

Hour number with no leading zero

5

HH

Hour number with leading zero, if applicable

05

M

Minutes number with no leading zero

5

MM

Minutes number with leading zero, if applicable

05

S

Seconds number with no leading zero

5

SS

Seconds number with leading zero, if applicable

55


Return value

DateTime.

Throws

EXCEPTION_DATA_CONVERSION -- If data conversion fails.

See also

SetDateTimeValue