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

Article
12/03/2008

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

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

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

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

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

Parameters

schema
A Guid object that specifies the schema table to be returned.

restrictions
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
If true, inline errors cause an exception to be thrown; otherwise DataRow.GetColumnError is used to determine the error generated.

Return Value

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 null cells that would not normally be null. 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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms