ENVITime::GetString

The GetString method returns an ENVITime string in a specified format.

Example

e = ENVI(/HEADLESS)

time = ENVITime(ACQUISITION='2015-03-06T18:39:32Z')

Print, time.GetString(FORMAT='yyyy/MMMM/dd')

IDL prints:

2015/March/06

Continue:

Print, time.GetString(FORMAT='[dd/MM/yy - hh:mm:ss]')

IDL prints:

[06/03/15 - 18:39:32]

Syntax

Result = ENVITime.GetString([, ERROR=value] [, FORMAT=string])

Arguments

None

Keywords

ERROR (optional)

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

FORMAT (optional)

Set this keyword to a string that indicates the format of the returned date and time. The following are valid values that the string can include:

yy: Display the year as a 2-digit number (00–99).
yyyy: Display the year as a 4-digit number (100–9999).
M: Display the month as a number without a leading zero (1–12).
MM: Display the month as a number with a leading zero (01–12).
MMM: Display the month as an abbreviation (Jan–Dec). Localized.
MMMM: Display the month as a full month name (January–December). Localized.
d: Display the day as a number without a leading zero (1–31).
dd: Display the day as a number with a leading zero (01–31).
h: Display the hour as a number without a leading zero (0–23).
hh: Display the hour as a number with a leading zero (00–23).
m: Display the minute as a number without a leading zero (0–59).
mm: Display the minute as a number with a leading zero (00–59).
s: Display the second as a number without a leading zero (0–59).
ss: Display the second as a number with a leading zero (00–59).

Version History

ENVI 5.6

Introduced

API Version

4.2