VpnChannel.ActivateForeground(String, ValueSet) 方法

定義

命名空間:

Windows.Networking.Vpn

在前景啟動 VPN 應用程式。 這通常用來讓使用者輸入認證。 您只能從IVpnPlugin.Connect的實作呼叫ActivateForeground。 當應用程式在前景時，會暫停一般的 Connect 逾時。

如果長時間暫停 (大約 10 分鐘) ，則會取消 ActivateForeground 呼叫。 如果無法啟動，則外掛程式最好支援不需要使用者介面的驗證方法， (UI) 。

適用于支援 Web 架構的驗證配置，例如安全性聲明標記語言 (SAML) 和 Azure Active Directory (AAD) 驗證。

public:
 virtual ValueSet ^ ActivateForeground(Platform::String ^ packageRelativeAppId, ValueSet ^ sharedContext) = ActivateForeground;

ValueSet ActivateForeground(winrt::hstring const& packageRelativeAppId, ValueSet const& sharedContext);

public ValueSet ActivateForeground(string packageRelativeAppId, ValueSet sharedContext);

function activateForeground(packageRelativeAppId, sharedContext)

Public Function ActivateForeground (packageRelativeAppId As String, sharedContext As ValueSet) As ValueSet

參數

packageRelativeAppId

String

Platform::String

winrt::hstring

字串，包含要啟動的前景應用程式 (PRAID) 套件相對應用程式識別碼。

sharedContext

ValueSet

ValueSet物件，用來將資訊傳遞至前景應用程式。 前景應用程式可以從啟用事件引數存取這些引數。

傳回

ValueSet

ValueSet物件，其中包含您選擇的Windows 執行階段物件，該物件會從前景應用程式傳回 VPN 外掛程式，指出前景要求的結果。

Windows 需求

裝置系列	Windows 11 (已於 10.0.22000.0 引進)
API contract	Windows.Foundation.UniversalApiContract (已於 v14.0 引進)
應用程式功能	networkingVpnProvider

備註

注意

在 VPN 外掛程式的 IVpnPlugin.Connect 方法實作之外呼叫此 API 將會失敗。

使用前景啟用機制需要處理數個位置的啟用。

在您的 IVpnPlugin.Connect 方法中，您會使用正確的套件相對應用程式識別碼來呼叫 ActivateForeground (PRAID) ，以及包含您要傳送至前景應用程式之所有值的 ValueSet 。

在前景應用程式中，您需要攔截啟用。 前景應用程式將會以VpnForeground的Windows.ApplicationModel.ActivationKind值啟動。 啟用引數的類型為 Windows.Networking.Vpn.VpnForegroundActivatedEventArgs，且會包含三個欄位。

1. ProfileName (String) 。
2. SharedCoNtext (ValueSet) 。
3. ActivationOperation (Windows.Networking.Vpn.VpnForegroundActivationOperation。

前景應用程式接著可以設定應用程式的使用者介面 (UI) ，以處理所需的授權 (或任何需要的資料) 。 完成時，您必須呼叫ActivationOperation的Complete方法，並傳入您想要傳回至 IVpnPlugin.Connect呼叫之值的ValueSet。

回到IVpnPlugin.Connect呼叫中，使用從 ActivateForeground傳回的ValueSet來判斷驗證是否成功，並處理任何錯誤。