Share via

  • Article

AdomdConnection.GetSchemaDataSet Method (String, AdomdRestrictionCollection, Boolean)

Returns schema information from a data source by using a schema name to identify the information, applying any specified restrictions to the information, and optionally throwing an exception when inline errors occur.

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

Syntax

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

returnValue = instance.GetSchemaDataSet(schemaName, _
    restrictions, throwOnInlineErrors)

public DataSet GetSchemaDataSet(
    string schemaName,
    AdomdRestrictionCollection restrictions,
    bool throwOnInlineErrors
)

public:
DataSet^ GetSchemaDataSet(
    String^ schemaName, 
    AdomdRestrictionCollection^ restrictions, 
    bool throwOnInlineErrors
)

member GetSchemaDataSet : 
        schemaName:string * 
        restrictions:AdomdRestrictionCollection * 
        throwOnInlineErrors:bool -> DataSet 

public function GetSchemaDataSet(
    schemaName : String, 
    restrictions : AdomdRestrictionCollection, 
    throwOnInlineErrors : boolean
) : DataSet

Parameters

  • schemaName
    Type: System.String
    The name of the schema to be retrieved.
  • throwOnInlineErrors
    Type: System.Boolean
    If true, inline errors cause an exception to be thrown; otherwise, DataRow.GetColumnError is used to determine the error generated.

Return Value

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

Remarks

If throwOnInlineErrors is true, this method behaves identically to GetSchemaDataSet. If throwOnInlineErrors is false, and there are errors that occur while retrieving schema information, the resulting DataSet may contain nulla null reference (Nothing in Visual Basic) cells that would not normally be nulla null reference (Nothing in Visual Basic). To determine the details of the errors that occur, you can use the DataRow.GetColumnsInError, DataRow.GetColumnError, DataRow.HasErrors, DataSet.HasErrors, and DataTable.HasErrors methods and properties.