GetEnumerator Method (TdQueryBand)

Returns an enumerator that is used to iterate through all the defined Query Bands.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function GetEnumerator() As IEnumerator(Of KeyValuePair(Of String,Object))

'Usage
 
Dim instance As TdQueryBand
Dim value As IEnumerator(Of KeyValuePair(Of String,Object))
 
value = instance.GetEnumerator()

public IEnumerator<KeyValuePair<string,object>> GetEnumerator()

public:
IEnumerator<KeyValuePair<String^,Object^>>^ GetEnumerator();

Return Value

Returns an enumerator.

Remarks

When using the enumerator to iterate through the Query Bands, each item is a KeyValuePair<String, Object>. (Collections.Generic.KeyValuePair`2 for more information).

For further information refer to Collections.Generic.IEnumerable`1.GetEnumerator.

Example

The following example iterates through Query Bands, and will have the following output:

Key = ProxyUser, Value = user1
Key = Group, Value = gardening
Key = ApplicationName, Value = Accounting

public void EnumerationExample()
{
    TdQueryBand queryBand = new TdQueryBand("ProxyUser = user1; Group=gardening; ApplicationName=Accounting;");
    
    foreach (KeyValuePair<String, Object> temp in queryBand)
    {
        Console.WriteLine("Key = {0}, Value = {1}", temp.Key, temp.Value);
    }
}

Requirements

Product	Versions	Platforms
.NET	6, 7	Windows, Linux, MacOS
.NET Framework	4.6.2, 4.7, 4.7.1, 4.7.2, 4.8	Windows
.NET Standard	2.0	Windows, Linux, MacOS

Reference

TdQueryBand Class
TdQueryBand Members