Clustered Property Example (VB)

Microsoft ActiveX Data Objects (ADO)

ADOX 2.5

Clustered Property Example (VB)

This example demonstrates the Clustered property of an Index. Note that Microsoft Jet databases do not support clustered indexes, so this example will return False for the Clustered property of all indexes in the Northwind database.

' BeginClusteredVB
Sub Main()
    On Error GoTo ClusteredXError
    
    Dim cnn As New ADODB.Connection
    Dim cat As New ADOX.Catalog
    Dim tblLoop As ADOX.Table
    Dim idxLoop As ADOX.Index
    Dim strCnn As String

    strCnn = "Provider='SQLOLEDB';Data Source='MySqlServer';Initial Catalog='pubs';" & _
        "Integrated Security='SSPI';"
    ' Connect the catalog.
    cnn.Open strCnn
    cat.ActiveConnection = cnn
    
    ' Enumerate Tables
    For Each tblLoop In cat.Tables
        'Enumerate Indexes
        For Each idxLoop In tblLoop.Indexes
            Debug.Print tblLoop.Name & " " & _
                idxLoop.Name & " " & idxLoop.Clustered
        Next idxLoop
    Next tblLoop

    'Clean up
    cnn.Close
    Set cat = Nothing
    Set cnn = Nothing
    Exit Sub
    
ClusteredXError:

    Set cat = Nothing
    
    If Not cnn Is Nothing Then
        If cnn.State = adStateOpen Then cnn.Close
    End If
    Set cnn = Nothing

    If Err <> 0 Then
        MsgBox Err.Source & "-->" & Err.Description, , "Error"
    End If
End Sub
' EndClusteredVB

See Also

Catalog Object | Clustered Property | Index Object | Table Object

© 1998-2003 Microsoft Corporation. All rights reserved.