DataCommand.DeriveSchema メソッド
指定されたコマンドから返されるスキーマを取得し、データ リーダーの項目とブロックのレイアウトを示します。
名前空間: Microsoft.VisualStudio.Data
アセンブリ: Microsoft.VisualStudio.Data (Microsoft.VisualStudio.Data.dll 内)
構文
'宣言
Public Overridable Function DeriveSchema ( _
command As String, _
commandType As Integer, _
parameters As DataParameter(), _
commandTimeout As Integer _
) As DataReader
public virtual DataReader DeriveSchema(
string command,
int commandType,
DataParameter[] parameters,
int commandTimeout
)
public:
virtual DataReader^ DeriveSchema(
String^ command,
int commandType,
array<DataParameter^>^ parameters,
int commandTimeout
)
abstract DeriveSchema :
command:string *
commandType:int *
parameters:DataParameter[] *
commandTimeout:int -> DataReader
override DeriveSchema :
command:string *
commandType:int *
parameters:DataParameter[] *
commandTimeout:int -> DataReader
public function DeriveSchema(
command : String,
commandType : int,
parameters : DataParameter[],
commandTimeout : int
) : DataReader
パラメーター
command
型 : Stringデータ ソースにスキーマの詳細を取得するには、コマンド。
commandType
型 : Int32指定する名前付きコマンドのコマンドの型 command のパラメーターの内容を解釈する方法を示します。
parameters
型 : array<Microsoft.VisualStudio.Data.DataParameter[]指定したコマンドの種類の DataParameter のオブジェクトの配列。 これは入力パラメーターですが、DDEX プロバイダーは、設定できる、および戻り値パラメーターのプロパティが。 ただし、これらはスキーマを取得と設定されません。
commandTimeout
型 : Int32スキーマの派生をキャンセルし、呼び出し元に戻す前にクライアントをブロック時間 (秒)。 0 という値は無限タイムアウトを示しています; 値 -1 は、プロバイダーの既定値を表示します。
戻り値
型 : Microsoft.VisualStudio.Data.DataReader
DataReader オブジェクトを返します。このオブジェクトは指定されたコマンドを実行したときに返されるリーダーのオブジェクトに項目とブロックのつまり、スキーマのレイアウトを記述する前方スクロール専用、読み取り専用データ ストリームを提供します。
例外
例外 | 条件 |
---|---|
ArgumentNullException | コマンドまたは asyncCommandEvents が null です。 |
ArgumentException | commandType は無効な型を指定します。 |
ArgumentOutOfRangeException | commandTimeout は -1 未満です。 |
NotSupportedException | プロバイダーはこのメソッドをサポートしません。 |
解説
返されるデータ リーダーのスキーマは、このメソッドによって特定の形式にする必要があります。 返される各結果に対してコマンドを実行した場合、そこにデータ リーダーに結果必要があります。 これらの結果に返される項目を説明するブロックを含める必要があります。コマンドを実行した場合。 ついては、次の項目を含める必要があります:
名前 (文字列) : 項目の名前。
序数 (Int32) : 項目の位置。
UserDataType (文字列) : 項目 (たとえば、「myType」) のユーザーのデータ型。
NativeDataType (文字列) : たとえば、nvarchar 項目 (「」) のネイティブ データ型。
ProviderDataType (Int32) : 項目 (たとえば System.Data.DbType.StringFixedLength) プロバイダーのデータ型。
FrameworkDataType (型): 項目 (たとえば、System.Int32) のフレームワークのデータ型。
長さ (Int32) : 項目の最大長、該当する場合。
精密 (Int32): 項目の精度、該当する場合。
スケール (Int32) : 項目の規模、該当する場合。
null 許容 (ブール型): 項目の null 値許容。
プロバイダーが (たとえば、データ型のあるフォーム) サポートしない項目は、現在 nullnull 参照 (Visual Basic では Nothing)に設定されている必要があります。
注意
パラメーターは、ほかの例外の派生がプロバイダー指定された理由で失敗したことを示します。
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。