Поделиться через

IVsDataProvider.GetUnsupportedReason - метод (Guid, CommandID, Object)

  • Статья

Возвращает локализованную строку, в которой объясняется, почему операция не поддерживается для указанного источника данных DDEX.

Пространство имен:  Microsoft.VisualStudio.Data.Core
Сборка:  Microsoft.VisualStudio.Data.Core (в Microsoft.VisualStudio.Data.Core.dll)

Синтаксис

'Декларация
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

Параметры

  • source
    Тип: Guid

    Идентификатор источника данных DDEX.

  • command
    Тип: CommandID

    Команда, которая определяет операцию.

  • context
    Тип: Object

    Объект, представляющий контекст, в котором операция существует.

Возвращаемое значение

Тип: String
Локализованная строка, в которой объясняется, почему указанная операция не поддерживается, если операция фактически не поддерживается; в противном случае nullссылка NULL (Nothing в Visual Basic).

Исключения

Исключение Условие
ArgumentNullException

Значение параметра command — nullссылка NULL (Nothing в Visual Basic).
[<ANY>]

Реализация GetUnsupportedReason поставщика DDEX выдавать исключения.

Заметки

Этот метод позволяет клиентам DDEX предоставить пользователям конкретной операции, в которых рассказывается причину, почему они попытка выполнить не поддерживается в окружающей среды в данный момент. Среда может отличаться в зависимости от того, какой выпуск Visual Studio выполняется и которой компоненты среды выполнения устанавливаются на компьютере. Первое обычно настраивается с помощью выпуска Visual Studio (например, ограничивая некоторые команды в выпусках), а второй обычно задается реализацией IVsDataProviderDynamicSupport поставщика, если таковое имеется.

Многие операции выполняются в рамках определенного большего контекста. Простейшим примером этого открытую команду для подключения, которое происходит в контексте конкретного соединения. Параметр contextGetUnsupportedReason позволяет передавать в распознать два объекта и использоваться как часть определения причину не поддерживает операции.

В начале этого метода, указав наличие выпуска Visual Studio причину не поддерживает операции. Если этот запрос возвращает nullссылка NULL (Nothing в Visual Basic) (т е Visual Studio отсутствует причину не поддерживает операции) и поставщик использует реализацию IVsDataProviderDynamicSupport, оно запросы поставщика для причинам не поддерживает операции.

Примеры

В следующем примере кода показан вызов метода IsOperationSupported, чтобы определить, поддерживает ли поставщик удаление указанный узел обозревателя данных. Если это не так, то код вызывает GetUnsupportedReason для определения соответствующее сообщение для описания причины операция не поддерживается.

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;
    }
}

Безопасность платформы .NET Framework

См. также

Ссылки

IVsDataProvider Интерфейс

GetUnsupportedReason - перегрузка

Microsoft.VisualStudio.Data.Core - пространство имен