Interface ITimeDuration

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll

Provides access to members that control the Time Duration.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("953DC994-AA0D-4193-9C1F-469B60D61711")]
public interface ITimeDuration

Properties

Days

The time duration days component.

int Days { get; set; }

Property Value

int

Hours

The time duration hours component.

int Hours { get; set; }

Property Value

int

Minutes

The time duration minutes component.

int Minutes { get; set; }

Property Value

int

Nanoseconds

The time duration nanoseconds component.

int Nanoseconds { get; set; }

Property Value

int

Positive

Indicates whether the time duration value is positive or negative.

bool Positive { get; set; }

Property Value

bool

Seconds

The time duration seconds component.

int Seconds { get; set; }

Property Value

int

Methods

AddDays(double)

Adds the input amount of days to the time duration.

void AddDays(double Value)

Parameters

Value double

AddDuration(ITimeDuration)

Adds a time duration.

void AddDuration(ITimeDuration TimeDuration)

Parameters

TimeDuration ITimeDuration

AddHours(double)

Adds the input amount of hours to the time duration.

void AddHours(double Value)

Parameters

Value double

AddMilliseconds(double)

Adds the input amount of milliseconds to the time duration.

void AddMilliseconds(double Value)

Parameters

Value double

AddMinutes(double)

Adds the input amount of minutes to the time duration.

void AddMinutes(double Value)

Parameters

Value double

AddNanoseconds(long)

Adds the input amount of nanoseconds to the time duration.

void AddNanoseconds(long Value)

Parameters

Value long

AddSeconds(double)

Adds the input amount of seconds to the time duration.

void AddSeconds(double Value)

Parameters

Value double

AddWeeks(double)

Adds the input amount of weeks to the time duration.

void AddWeeks(double Value)

Parameters

Value double

Compare(ITimeDuration)

Compares this time duration to the other time duration. Returns -1 if this time duration's value is less, 1 if greater, and 0 otherwise.

int Compare(ITimeDuration otherDuration)

Parameters

otherDuration ITimeDuration

Returns

int

IsZero()

Indicates whether the time duration's value is zero.

bool IsZero()

Returns

bool

QueryDayFraction()

The time duration day fraction portion as a day fraction. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

double QueryDayFraction()

Returns

double

QueryDayFractionNanoseconds()

The time duration day fraction portion as the number of nanoseconds elapsed since midnight. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

long QueryDayFractionNanoseconds()

Returns

long

QueryTicks()

Obtains the time duration as the number of ticks.

long QueryTicks()

Returns

long

Remarks

Using the QueryTicks function allows you to find the Ticks value, which is used in many Windows time controls.

QueryTotalDays()

Obtains the time duration as total days floating point value.

double QueryTotalDays()

Returns

double

QueryTotalHours()

Obtains the time duration as total hours floating point value.

double QueryTotalHours()

Returns

double

QueryTotalMinutes()

Obtains the time duration as total minutes floating point value.

double QueryTotalMinutes()

Returns

double

QueryTotalSeconds()

Obtains the time duration as total seconds floating point value.

double QueryTotalSeconds()

Returns

double

QueryWKSTimeDuration()

Obtains time as a WKSTimeDuration.

WKSTimeDuration QueryWKSTimeDuration()

Returns

WKSTimeDuration

QueryXMLTimeDurationString()

Obtains the time duration as an XML time duration string.

string QueryXMLTimeDurationString()

Returns

string

Reset()

Reset the time duration to zero.

void Reset()

Scale(double)

Scales the time duration by a scale factor.

void Scale(double scaleFactor)

Parameters

scaleFactor double

SetDayFraction(double)

The time duration day fraction portion as a day fraction. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

void SetDayFraction(double dayFraction)

Parameters

dayFraction double

SetDayFractionNanoseconds(long)

The time duration day fraction portion as the number of nanoseconds elapsed since midnight. Corresponds to the Hour, Minute, Second, and Nanoseconds properties.

void SetDayFractionNanoseconds(long dayFractionNanoseconds)

Parameters

dayFractionNanoseconds long

SetFromTicks(long)

Writes the time duration from a given number of ticks.

void SetFromTicks(long ticks)

Parameters

ticks long

SetFromWKSTimeDuration(ref WKSTimeDuration)

Writes the time from a given WKSTimeDuration value.

void SetFromWKSTimeDuration(ref WKSTimeDuration TimeDuration)

Parameters

TimeDuration WKSTimeDuration

SetFromXMLTimeDurationString(string)

Writes the time duration from an XML time duration string.

void SetFromXMLTimeDurationString(string xmlTimeDurationString)

Parameters

xmlTimeDurationString string

SubtractDuration(ITimeDuration)

Subtracts a time duration.

void SubtractDuration(ITimeDuration TimeDuration)

Parameters

TimeDuration ITimeDuration