Share via


AdomdConnection.GetSchemaDataSet Method (String, AdomdRestrictionCollection)

Returns schema information from a data source by using a schema name to identify which schema to retrieve and by applying any specified restrictions to the information.

Namespace:  Microsoft.AnalysisServices.AdomdClient
Assembly:  Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)

Syntax

'Declaration
Public Function GetSchemaDataSet ( _
    schemaName As String, _
    restrictions As AdomdRestrictionCollection _
) As DataSet
'Usage
Dim instance As AdomdConnection
Dim schemaName As String
Dim restrictions As AdomdRestrictionCollection
Dim returnValue As DataSet

returnValue = instance.GetSchemaDataSet(schemaName, _
    restrictions)
public DataSet GetSchemaDataSet(
    string schemaName,
    AdomdRestrictionCollection restrictions
)
public:
DataSet^ GetSchemaDataSet(
    String^ schemaName, 
    AdomdRestrictionCollection^ restrictions
)
member GetSchemaDataSet : 
        schemaName:string * 
        restrictions:AdomdRestrictionCollection -> DataSet 
public function GetSchemaDataSet(
    schemaName : String, 
    restrictions : AdomdRestrictionCollection
) : DataSet

Parameters

  • schemaName
    Type: System.String
    The name of the schema to be retrieved.

Return Value

Type: System.Data.DataSet
A DataSet that represents the contents of the specified OLE DB schema table.

Remarks

The schema table is returned as a DataSet that has the same format as the OLE DB schema rowset specified by the schemaName parameter. Use the restrictions parameter to filter the rows to be returned in the DataSet. (For example, you can specify cube name and dimension name restrictions for the dimensions schema.)

Note

If the schema contains nested rowsets, more tables may be returned in the DataSet.