AdomdConnection.GetSchemaDataSet Method (String, AdomdRestrictionCollection, Boolean)

Artigo
12/03/2008

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

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

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

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

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

Parameters

schemaName
The name of the schema to be retrieved.

restrictions
A collection of AdomdRestriction objects that specifies the values for the restriction columns that the schema table uses.

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 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 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