Equality Operator (TdPeriodDate)

Compares two TdPeriodDate structures to determine whether the operand is equal to the operand.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Operator =( _
   ByVal left As TdPeriodDate, _
   ByVal right As TdPeriodDate _
) As Boolean

'Usage

public bool operator ==( 
   TdPeriodDate left,
   TdPeriodDate right
)

public:
bool operator ==( 
   TdPeriodDate left,
   TdPeriodDate right
)

Parameters

left: An instance of TdPeriodDate.
right: An instance of TdPeriodDate.

Return Value

A boolean is returned that indicates the result of the comparison.

Remarks

The beginning and ending bounds between the left and right operands are compared to determine whether two periods are equal. The two periods are equal if the following is true:

    left.Begin == right.Begin && left.End == right.Begin

The value returned is true if the left is equal to the right, false otherwise.

Return Value Description

Return Value	Description
`true`	left and right are TdPeriodDate.Null -or- left is equal to right.
`false`	left or right is Null -or- left is not equal to right.

true

left and right are TdPeriodDate.Null

-or-

left is equal to right.

false

left or right is Null

-or-

left is not equal to right.

Unlike comparison operators, Equality operators do not always return false when left and right operands are Null. Therefore the reverse condition can be considered true. TdDate implementation is very similar to the Nullable class in this regard.

Example

The following example shows that the Equality operator can safely be used in an if statement.

TdPeriodDate x = TdPeriodDate.Null;
TdPeriodDate y = new TdPeriodDate(new TdDate(2008, 10, 10), new TdDate(2008, 11, 30));
            
if (x == y)
{
    // x is equal to y.
    Console.WriteLine(@"X is equal to Y").
}
else
{
    // x is not equal y
    Console.WriteLine(@"X is not equal to Y").
}
            
y = TdPeriodDate.Null;
            
if (x == y)
{
    // x is equal to y.
    Console.WriteLine(@"X is equal to Y").
}
else
{
    // x is not equal y
    Console.WriteLine(@"X is not equal to Y").
}

Requirements

Target Platforms: Windows 7, Windows 8, Windows 8.1, Windows 10, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2

Reference

TdPeriodDate Structure
TdPeriodDate Members