Método DataCommand.DeriveSchema

Artigo
10/26/2012

Derivado o esquema retornado de um comando especificado, indicando o layout dos itens e os blocos em um leitor de dados.

Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (em Microsoft.VisualStudio.Data.dll)

Sintaxe

'Declaração
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

Parâmetros

command
Tipo: System.String
Um comando para que o que derivam de esquema específico a uma fonte de dados.

commandType
Tipo: System.Int32
O tipo de comando para o comando indicado, especificando como interpretar o conteúdo do parâmetro de command .

parameters
Tipo: array<Microsoft.VisualStudio.Data.DataParameter[]
Uma matriz de objetos de DataParameter para o tipo especificado de comando.Embora esse seja um parâmetro de entrada, o provedor de DDEX ainda pode definir para fora propriedades individuais no e nos parâmetros do valor de retorno.Em o entanto, eles não serão preenchidos ao derivar o esquema.

commandTimeout
Tipo: System.Int32
O período de tempo, em segundos, para bloquear o cliente antes de cancelar a derivação de esquema e retornar para o chamador.Um valor de 0 indica o tempo limite infinito; um valor de -1 indica uma opção de provedor.

Valor de retorno

Tipo: Microsoft.VisualStudio.Data.DataReader
Retorna um objeto de DataReader .Este objeto fornece um fluxo de dados somente para frente, somente leitura que descreve o layout de itens e os blocos, isto é, o esquema, para o objeto leitor retornado em cima de executar o comando especificado.

Exceções

Exceção	Condição
ArgumentNullException	O comando ou os asyncCommandEvents são zero.
ArgumentException	Especifica o tipo de um tipo válido.
ArgumentOutOfRangeException	O commandTimeout é menor que -1.
NotSupportedException	O provedor não suporta esse método.

Comentários

O esquema leitor de dados retornados por esse método deve seguir um formato específico.Para cada resultado que seria retornada ao executar o comando, deve haver um resultado no leitor de dados.Cada um de esses resultados deve conter blocos que descrevem os itens que seriam retornados para executar o comando.a descrição deve conter os seguintes itens:

Nome (cadeia de caracteres): o nome do item.
Ordinal (Int32): a posição do item.
UserDataType (cadeia de caracteres): o tipo de dados do usuário de item (por exemplo, “myType”).
NativeDataType (cadeia de caracteres): o tipo de dados nativo de item (por exemplo, “nvarchar”).
ProviderDataType (Int32): o tipo de dados do provedor de item (por exemplo, System.Data.DbType.StringFixedLength).
FrameworkDataType (Tipo): o tipo de dados da estrutura de item (por exemplo, System.Int32).
Comprimento (Int32): o comprimento máximo de um item, se aplicável.
Precisão (Int32): a precisão de um item, se aplicável.
Escala (Int32): a escala de um item, se aplicável.
Anulável (booleano): a nulidade de um item.

Esses itens que um provedor não suporta (por exemplo, alguns formulários do tipo de dados) deve estar presente mas definir a nulluma referência nula (Nothing no Visual Basic).

Observação
Outras exceções que ocorrem indica que a derivação de parâmetro falhou para um motivo provedor- especificada.

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

DataCommand Classe

Namespace Microsoft.VisualStudio.Data

DataReader

Partilhar via