• Article

AdomdConnection.GetSchemaDataSet Method (Guid, array<Object[])

Returns schema information from a data source by using a Guid object to specify which schema information to return 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 ( _
    schema As Guid, _
    restrictions As Object() _
) As DataSet
'Usage
Dim instance As AdomdConnection
Dim schema As Guid
Dim restrictions As Object()
Dim returnValue As DataSet

returnValue = instance.GetSchemaDataSet(schema, _
    restrictions)

public DataSet GetSchemaDataSet(
    Guid schema,
    Object[] restrictions
)

public:
DataSet^ GetSchemaDataSet(
    Guid schema, 
    array<Object^>^ restrictions
)

member GetSchemaDataSet : 
        schema:Guid * 
        restrictions:Object[] -> DataSet 

public function GetSchemaDataSet(
    schema : Guid, 
    restrictions : Object[]
) : DataSet

Parameters

  • schema
    Type: System.Guid
    A Guid object that specifies the schema table to be returned.
  • restrictions
    Type: array<System.Object[]
    An array of Object objects that specifies the values for the restriction columns that the schema table uses. These values are applied in the order of the restriction columns. That is, the first restriction value applies to the first restriction column, the second restriction value applies to the second restriction column, and so on.

Return Value

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

Remarks

The schema rowset is returned as a DataSet that has the same format as the OLE DB schema rowset specified by the schema parameter. Use the restrictions parameter to filter the rows to be returned in the DataSet. (For example, you can specify restrictions for table name, type, owner, or schema). When you pass values in the array, include empty strings or nulls for array elements that do not contain values. If you pass an empty array to restrictions, all rows are returned in default order. Values in the array correspond to the order of the columns in the OLE DB or OLE DB for OLAP specifications.

If a Guid is provided that is not associated with a schema rowset, or if the schema rowset associated with the provided Guid is not supported by the server, the InvalidOperationException exception is thrown. Similarly, an exception is thrown if an error occurs while retrieving the schema rowset from the provider.

The AdomdSchemaGuid contains a collection of Guid objects that represents the most commonly supported OLE DB and XML for Analysis schema rowsets.

Note

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