Click or drag to resize

SetAMExt Function (String)

X#
Set the morning extension for time strings in 12-hour format.

Namespace:  XSharp.Core
Assembly:  XSharp.Core (in XSharp.Core.dll) Version: 2.21
Syntax
Copy
 FUNCTION SetAMExt(
	cAMExt AS STRING
) AS STRING
Request Example View Source

Parameters

cAMExt
Type: String
The extension to be used for time strings that occur in the morning hours.
This string can be up to eight characters in length — additional characters are ignored.
The initial default depends on SetInternational(), which you can refer to for more information.

Return Value

Type: String
Remarks
Time strings formatted using the 12-hour time format have an extension to specify if the time is in the morning or the evening. SetAMExt() allows you to programmatically set the extension identifying morning time strings (that is, those between 12:00:00 midnight and just before 12:00:00 noon).
A typical extension for morning time strings is "AM", which is how the function derives its name. The initial default for the morning extension is affected by SetInternational(), which you can refer to for more information.
Use GetAMExt() to retrieve the current value of this setting.
Examples
This example turns on the 12-hour time format and displays a time string using two different extensions:
X#
Copy
1SetAMPM(TRUE)
2SetAMExt(" am")
3? TString(3800)    // 01:03:20 am
4SetAMExt(" morning")
5? TString(3800)    // 01:03:20 morning
See Also