Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

OdbcConnection::GetSchema Method (String^, array<String^>^)

 

Returns schema information for the data source of this OdbcConnection using the specified string for the schema name and the specified string array for the restriction values.

Namespace:   System.Data.Odbc
Assembly:  System.Data (in System.Data.dll)

public:
virtual DataTable^ GetSchema(
	String^ collectionName,
	array<String^>^ restrictionValues
) override

Parameters

collectionName
Type: System::String^

Specifies the name of the schema to return.

restrictionValues
Type: array<System::String^>^

Specifies a set of restriction values for the requested schema.

Return Value

Type: System.Data::DataTable^

A DataTable that contains schema information.

When collectionName is specified as null, the DataTable contains information about all the metadata that is available, and its restrictions.

The restrictionValues parameter can supply n depth of values which are specified by the restrictions collection for a specific collection. In order to set values on a given restriction, and not set the values of other restrictions, you must set the preceding restrictions to null and then put the appropriate value in for the restriction that you would like to specify a value for.

An example of this is the "Tables" collection. If the "Tables" collection has three restrictions (database, owner, and table name), and you want to get back only the tables associated with the owner "Carl," then you would need to pass in at least the following values: null, "Carl". If a restriction value is not passed in, the default values are used for that restriction. This is the same mapping as passing in null, which is different from passing in an empty string for the parameter value. In that case, the empty string ("") is considered to be the value for the specified parameter.

System_CAPS_noteNote

All restrictions that apply to SQLStatistics method will apply to the ODBCConnection.GetSchema("indexes") collection.

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft