This document is archived and information here might be outdated.  Recommended version.


ITimeRelationalOperator.Within Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (System)  

ITimeRelationalOperator.Within Method

Indicates whether this time value is contained (is within) the other time value.

[Visual Basic .NET]
Public Function Within ( _
    ByVal otherTimeValue As ITimeValue _
) As Boolean
[C#]
public bool Within (
    ITimeValue otherTimeValue
);
[C++]
HRESULT Within(
  ITimeValue* otherTimeValue,
  VARIANT_BOOL* Within
);
[C++]

Parameters otherTimeValue [in]
otherTimeValue is a parameter of type ITimeValue Within [out, retval] Within is a parameter of type VARIANT_BOOL

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

This function can be used to find out if the current time is contained fully within the time extent passed in.  The start times can be equal or the end times can be equal and the function will still be TRUE.

See Also

ITimeRelationalOperator Interface