Google Earth COM API Documentation Document Version: 1.0 - Last modified:

ITimeGE Interface Reference

This represents a date and time. More...

import "earth.idl";

List of all members.

Public Types
enum	TimeTypeGE { TimeNegativeInfinityGE = -1, TimeFiniteGE = 0, TimePositiveInfinityGE = 1 }
	Possible types of time. More...
Public Member Functions
HRESULT	Clone ([out, retval] ITimeGE **pTime)
	Creates a writeable clone.
HRESULT	ConvertToZone ([in] double timeZone,[out, retval] ITimeGE **pTime)
	Coverts time to a different time zone.
Properties
TimeTypeGE	Type [get, set]
	Type of time (infinite or finite).
int	Year [get, set]
	Year.
int	Month [get, set]
	Month.
int	Day [get, set]
	Day.
int	Hour [get, set]
	Hour.
int	Minute [get, set]
	Minute.
int	Second [get, set]
	Second.
double	TimeZone [get, set]
	TimeZone.

---

Detailed Description

This represents a date and time.

This interface is used to represent a date and time inside Google Earth. The time is given in a certain time zone, specified by TimeZone. It could be converted to different time zones with ConvertToZone.

Associated GUIDs:

• IID_ITimeGE = {0xE39391AE,0x51C0,0x4FBD, {0x90,0x42,0xF9,0xC5,0xB6,0x09,0x44,0x45}};
• CLSID_TimeGE = {0x1AEDB68D,0x18A7,0x4CA9, {0xB4,0x1B,0x3C,0xE7,0xE5,0x9F,0xAB,0x24}};

See also:

ITimeIntervalGE

---

Member Enumeration Documentation

enum ITimeGE::TimeTypeGE

Possible types of time.

These are the possible representations of time.

Enumerator:

TimeNegativeInfinityGE	Represents negative infinity.
TimeFiniteGE	Represents a finite point in time.
TimePositiveInfinityGE	Represents positive infinity.

---

Member Function Documentation

HRESULT ITimeGE::Clone

(

[out, retval] ITimeGE **

pTime

)

Creates a writeable clone.

Useful when reading from read-only instance.

HRESULT ITimeGE::ConvertToZone	(	[in] double	timeZone,
		[out, retval] ITimeGE **	pTime
	)

Coverts time to a different time zone.

Converts from old time zone to a new specified zone and returns the result as a new (writable) instance of ITimeGE.

Parameters:

	timeZone	New time zone to convert time to. This format is explained in TimeZone.
	pTime	Output converted time.

Return values:

	S_OK	Successfully converted time.
	(other)	Appropriate error code.

---

Property Documentation

TimeTypeGE ITimeGE::Type [get, set]

Type of time (infinite or finite).

Use to check if time represents negative/positive infinity or a finite point in time.

Return values:

ERROR_WRITE_PROTECT

Data is write protected and cannot be changed.

int ITimeGE::Year [get, set]

Year.

Example: 2007

Return values:

	E_INFINITE_NUMBER	Type is not TimeFiniteGE
	ERROR_WRITE_PROTECT	Data is write protected and cannot be changed.

int ITimeGE::Month [get, set]

Month.

Valid values: 1 (January) through 12 (December).

Return values:

	E_INFINITE_NUMBER	Type is not TimeFiniteGE
	ERROR_WRITE_PROTECT	Data is write protected and cannot be changed.

int ITimeGE::Day [get, set]

Day.

Valid values: 1 through 28-31.

Return values:

	E_INFINITE_NUMBER	Type is not TimeFiniteGE
	ERROR_WRITE_PROTECT	Data is write protected and cannot be changed.

int ITimeGE::Hour [get, set]

Hour.

Valid values: 0 through 23.

Return values:

	E_INFINITE_NUMBER	Type is not TimeFiniteGE
	ERROR_WRITE_PROTECT	Data is write protected and cannot be changed.

int ITimeGE::Minute [get, set]

Minute.

Valid values: 0 through 59.

Return values:

	E_INFINITE_NUMBER	Type is not TimeFiniteGE
	ERROR_WRITE_PROTECT	Data is write protected and cannot be changed.

int ITimeGE::Second [get, set]

Second.

Valid values: 0 through 59.

Return values:

	E_INFINITE_NUMBER	Type is not TimeFiniteGE
	ERROR_WRITE_PROTECT	Data is write protected and cannot be changed.

double ITimeGE::TimeZone [get, set]

TimeZone.

Represented by a double in hours in respect to UTC (GMT 0). Can be a fraction for time zones that do not have an integer offset in hours from UTC.

Examples:

• Eastern Time (GMT -05:00): -5.0
• Newfoundland (GMT -03:30): -3.5
• Tehran (GMT +03:30): 3.5
• Vladivostok (GMT +10:00): 10.0

Return values:

ERROR_WRITE_PROTECT

data is write protected and cannot be changed.

---

The documentation for this interface was generated from the following file:

• earth.idl

©2008 Google - Google Home - About Google