Shortdateformatsource – Echelon OpenLNS User Manual

Page 384

Advertising
background image

OpenLNS Programmer's Reference

347

Here are some example strings you could use for this

property, with examples of how the short date would

appear for each one. The following examples assume the

DateFormatSeparator property is set to /.
ShortDateFormat

Example

MM/dd/yy

08/26/03

d/M/yyyy

26/8/2003

MMM/dd/yyyy

Aug/26/2003

yy/dd/MMMM

03/26/August

If you specify a character other than M, d, y, or the

DateFormatSeparator character when writing to this

property, the LCA, #87 lcaErrStringInvalidChar

exception will be thrown.
If you change the DateFormatSeparator property after

setting the ShortDateFormat property, OpenLNS will

automatically update it with the new separator character

for you.
You can use the ShortDateFormatSource property to

determine how the ShortDateFormat property should be

filled in.

Availability

Local, full, and lightweight clients.

Syntax

formatLocale.

ShortDateFormat

= dateFormat

Element

Description

formatLocale

The FormatLocale object being

acted upon.

dateFormat

The format used to display dates.

The allowable characters are M, d,

y, and the character specified as the

DateFormatSeparator

property.

Data Type

String.

Read/Write

Read/write.

Added to API

LNS Release 3.20.

ShortDateFormatSource

Summary

Determines whether OpenLNS should assign the

ShortDateFormat

property a value automatically based on

the Windows control panel Regional Options settings.

Availability

Local, full, lightweight, and independent clients.

Syntax

formatLocale. ShortDateFormatSource = source

Element

Description

formatLocale

The FormatLocale object being acted

upon.

Advertising