Método DataCommand.DeriveSchema (String, DataCommandType, array<IVsDataParameter , Int32)
Derivado o esquema retornado de um comando especificado.O esquema indica o layout dos itens e os blocos em um leitor de dados.
Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (em Microsoft.VisualStudio.Data.Framework.dll)
Sintaxe
'Declaração
Public Overridable Function DeriveSchema ( _
command As String, _
commandType As DataCommandType, _
parameters As IVsDataParameter(), _
commandTimeout As Integer _
) As IVsDataReader
public virtual IVsDataReader DeriveSchema(
string command,
DataCommandType commandType,
IVsDataParameter[] parameters,
int commandTimeout
)
public:
virtual IVsDataReader^ DeriveSchema(
String^ command,
DataCommandType commandType,
array<IVsDataParameter^>^ parameters,
int commandTimeout
)
abstract DeriveSchema :
command:string *
commandType:DataCommandType *
parameters:IVsDataParameter[] *
commandTimeout:int -> IVsDataReader
override DeriveSchema :
command:string *
commandType:DataCommandType *
parameters:IVsDataParameter[] *
commandTimeout:int -> IVsDataReader
public function DeriveSchema(
command : String,
commandType : DataCommandType,
parameters : IVsDataParameter[],
commandTimeout : int
) : IVsDataReader
Parâmetros
- command
Tipo: System.String
Um comando para que o que derivam de esquema específico a uma fonte de dados.
- commandType
Tipo: Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType
O tipo de comando que especifica como interpretar o conteúdo do parâmetro de command .O tipo de comando poderia ser um valor de enumeração de DataCommandType ou um tipo de comando personalizado definida por um provedor, que pode ser passado forçando uma conversão de um inteiro para a enumeração de DataCommandType .
- parameters
Tipo: array<Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]
Uma matriz de objetos de IVsDataParameter que representam os parâmetros do comando para o comando tipo especificado.
- 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.Services.SupportEntities.IVsDataReader
Um objeto IVsDataReader.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.
Implementações
IVsDataCommand.DeriveSchema(String, DataCommandType, array<IVsDataParameter[], Int32)
Exceções
Exceção | Condição |
---|---|
ArgumentNullException | o parâmetro de command é nulluma referência nula (Nothing no Visual Basic). |
ArgumentOutOfRangeException | O parâmetro de commandTimeout é menor que -1. |
Comentários
O esquema leitor de dados retornados por esse método deve seguir um formato específico.Para cada resultado que será retornado quando você executar o comando, deve haver um resultado no leitor de dados.Cada um de esses resultados deve conter blocos que descrevem os itens que serão retornados quando você executa 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.SqlDbType.NVarChar).
ProviderDbType (Int32): o tipo de dados do ADO.NET genérica 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 do item, se aplicável.
Precisão (Int32): a precisão do item, se aplicável.
Escala (Int32): a escala do item, se aplicável.
Anulável (booleano): a nulidade de 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 esquema 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.