IWidgetProvider.DeleteWidget(String, String) メソッド

定義

名前空間:

Microsoft.Windows.Widgets.Providers

ユーザーがウィジェット ホストからウィジェットを削除した場合など、サポートされているウィジェットのいずれかが削除されたことをウィジェット プロバイダーに通知します。

public:
 void DeleteWidget(Platform::String ^ widgetId, Platform::String ^ customState);

void DeleteWidget(winrt::hstring const& widgetId, winrt::hstring const& customState);

public void DeleteWidget(string widgetId, string customState);

function deleteWidget(widgetId, customState)

Public Sub DeleteWidget (widgetId As String, customState As String)

パラメーター

widgetId

String

Platform::String

winrt::hstring

ピン留めされていないウィジェットの一意識別子。 ウィジェット ID の値は、 によって WidgetManager動的に生成されます。 ウィジェット ID は、ウィジェットの作成時点からウィジェットが削除されるまで同じままです。 ウィジェット ID は、すべてのウィジェットとすべてのウィジェット プロバイダーで一意の値です。

customState

String

Platform::String

winrt::hstring

固定されていないウィジェットのカスタム状態を含む文字列。

注釈

特定のウィジェット ID に対してこのメソッドが呼び出されるとすぐに、プロバイダーはそのウィジェットに対する他の要求を受け取りません。 このメソッドが呼び出された時点で、削除されたウィジェットの ID を使用して のメソッド WidgetManager に対してそれ以上の呼び出しを行うと、効果はありません。