Método IVsDataProvider.GetUnsupportedReason (Guid, CommandID, Object)

Obtém uma cadeia de caracteres localizada que explica como uma operação não é suportada para a fonte de dados especificada de DDEX.

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

Sintaxe

'Declaração
Function GetUnsupportedReason ( _
    source As Guid, _
    command As CommandID, _
    context As Object _
) As String

string GetUnsupportedReason(
    Guid source,
    CommandID command,
    Object context
)

String^ GetUnsupportedReason(
    Guid source, 
    CommandID^ command, 
    Object^ context
)

abstract GetUnsupportedReason : 
        source:Guid * 
        command:CommandID * 
        context:Object -> string

function GetUnsupportedReason(
    source : Guid, 
    command : CommandID, 
    context : Object
) : String

Parâmetros

• source
  Tipo: Guid

  Um identificador de fonte de dados de DDEX.

• command
  Tipo: CommandID

  Um comando que identifica a operação.

• context
  Tipo: Object

  Um objeto que representa o contexto no qual a operação existe.

Valor de retorno

Tipo: String
Uma cadeia de caracteres localizada que explica como a operação especificada não é suportada, se a operação de fato não é suportado; caso contrário, nulluma referência nula (Nothing no Visual Basic).

Exceções

Exceção	Condição
ArgumentNullException	O parâmetro command é nulluma referência nula (Nothing no Visual Basic).
[<ANY>]	A implementação de GetUnsupportedReason do provedor de DDEX apresentou uma exceção.

Comentários

Esse método permite que clientes de DDEX para fornecer os usuários com um motivo específico que explicam como uma operação que tentaram executar não é suportado no ambiente atual. O ambiente pode diferir, dependendo do Visual Studio está executando e os componentes de tempo de execução são instalados no computador. O primeiro é geralmente controlados pela edição Visual Studio (por exemplo, para alguns comandos em express editions), enquanto o último normalmente é controlada pela implementação de IVsDataProviderDynamicSupport de um provedor, se houver.

Muitas operações ocorrem em um determinado contexto maior. O exemplo mais simples deste comando é aberto para a conexão, que ocorre no contexto de uma conexão específico. O parâmetro de context de GetUnsupportedReason permite que um objeto reconhecível a ser passado e usado como parte de determinar a razão não suporte a operação.

Inicia este método determinando se a edição Visual Studio tem uma razão para não suportar operação. Se esta consulta retorna nulluma referência nula (Nothing no Visual Basic) (isto é, o Visual Studio não tem razão para não suportar operação) e o provedor forneceu uma implementação de IVsDataProviderDynamicSupport , consulte o provedor para uma razão para não suportar operação.

Exemplos

O código a seguir demonstra como chamar o método de IsOperationSupported para determinar se o provedor suporta excluir um nó específico do gerenciador de dados. Caso contrário, o código chama GetUnsupportedReason para determinar uma mensagem apropriada descrever como a operação não é suportada.

using System;
using System.Windows.Forms;
using System.ComponentModel.Design;
using Microsoft.VisualStudio.Data.Core;
using Microsoft.VisualStudio.Data.Services;

public class DDEX_IVsDataProviderExample7
{
    public static bool AllowDelete(IVsDataProvider provider,
        IVsDataExplorerNode node)
    {
        if (!provider.IsOperationSupported(StandardCommands.Delete, node))
        {
            MessageBox.Show(provider.GetUnsupportedReason(
                StandardCommands.Delete, node));
            return false;
        }
        return true;
    }
}

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ável.

Consulte também

Referência

IVsDataProvider Interface

Sobrecargas GetUnsupportedReason

Namespace Microsoft.VisualStudio.Data.Core