Share via


TupleCollection Class

Gets a read-only collection of Tuple objects contained by a Set.

Namespace: Microsoft.AnalysisServices.AdomdClient
Assembly: Microsoft.AnalysisServices.AdomdClient (in microsoft.analysisservices.adomdclient.dll)

Syntax

'Declaration
<DefaultMemberAttribute("Item")> _
Public NotInheritable Class TupleCollection
    Implements ICollection, IEnumerable
[DefaultMemberAttribute("Item")] 
public sealed class TupleCollection : ICollection, IEnumerable
[DefaultMemberAttribute(L"Item")] 
public ref class TupleCollection sealed : ICollection, IEnumerable
/** @attribute DefaultMemberAttribute("Item") */ 
public final class TupleCollection implements ICollection, IEnumerable
DefaultMemberAttribute("Item") 
public final class TupleCollection implements ICollection, IEnumerable

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.AdomdClient.TupleCollection

Example

The following subroutine, given a CellSet and the total number of cells for which information should be displayed, iterates through the Tuples collection and displays information for each tuple:

Public Sub ListTupleCollection(ByRef AxisToCheck As Axis, _
    Optional ByVal Count As Integer = 10)

    ' Because a Set object can represent thousands of tuples,
    ' the Count parameter limits the output to a 
    ' specified number of cells.

    ' Check the parameter before performing actions on it.
    If AxisToCheck Is Nothing Then
        Throw New System.ArgumentNullException("AxisToCheck")
    Else
        ' Iterate through the Tuples collection of the
        ' Set object. 
        Try
            Dim tupleToCheck As Tuple
            Dim tupleCount As Integer
            Dim tupleIndex As Integer

            tupleCount = AxisToCheck.Set.Tuples.Count

            Debug.WriteLine("Found " & tupleCount & _
                " tuple(s) in axis:")

            If tupleCount > Count Then tupleCount = Count
            If tupleCount > 0 Then
                For tupleIndex = 0 To tupleCount
                    tupleToCheck = AxisToCheck.Set.Tuples(tupleIndex)
                    Debug.WriteLine("Tuple: " & _
                        tupleToCheck.TupleOrdinal)
                    Debug.WriteLine("  No. of members:    " & _
                        tupleToCheck.Members.Count)
                Next
            End If
        Catch ex As AdomdConnectionException
            ' The connection could not be opened or was disconnected.
            ' This error can occur at any time, if the provider is 
            ' disconnected from the server.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdErrorResponseException
            ' A response is received from a provider which indicates an error.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdUnknownResponseException
            ' A response has been returned from the provider that 
            ' was not understood.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdCacheExpiredException
            ' A cached version of an ADOMD.NET object is no longer valid.
            ' This error is typically raised when reviewing metadata.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdException
            ' Any other error raised by ADOMD.NET.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As Exception
            ' Any other error.
            Debug.WriteLine(ex)
            Throw ex
        End Try
    End If
End Sub

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

TupleCollection Members
Microsoft.AnalysisServices.AdomdClient Namespace