Share via

  • Article

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

Returns schema information from a data source by using a Guid object to identify the information, applying any specified restrictions on 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 ( _
    schema As Guid, _
    restrictions As Object(), _
    throwOnInlineErrors As Boolean _
) As DataSet
'Usage
Dim instance As AdomdConnection
Dim schema As Guid
Dim restrictions As Object()
Dim throwOnInlineErrors As Boolean
Dim returnValue As DataSet

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

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

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

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

public function GetSchemaDataSet(
    schema : Guid, 
    restrictions : Object[], 
    throwOnInlineErrors : boolean
) : 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 are used by the schema table. 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.
  • 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 rowset.

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.