Freigeben über


VpnChannel.ActivateForeground(String, ValueSet) Methode

Definition

Aktiviert die VPN-App im Vordergrund. Dies wird häufig verwendet, um dem Benutzer die Eingabe von Anmeldeinformationen zu ermöglichen. Sie können ActivateForeground- nur von Ihrer Implementierung von IVpnPlugin.Connectaufrufen. Während sich die App im Vordergrund befindet, wird das reguläre Connect Timeout angehalten.

Der ActivateForeground Anruf wird abgebrochen, wenn eine lange Pause (ca. 10 Minuten) besteht. Wenn das Plug-In nicht gestartet werden kann, sollte das Plug-In idealerweise eine Authentifizierungsmethode unterstützen, die keine Benutzeroberfläche (UI) benötigt.

Soll webbasierte Authentifizierungsschemas wie Security Assertion Markup Language (SAML) und Azure Active Directory (AAD)-Authentifizierung unterstützen.

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

Parameter

packageRelativeAppId
String

Platform::String

winrt::hstring

Eine Zeichenfolge, die den paketrelativen Anwendungsbezeichner (PRAID) der Vordergrund-App enthält, die gestartet werden soll.

sharedContext
ValueSet

Ein ValueSet- Objekt, das zum Übergeben von Informationen an die Vordergrund-App verwendet wird. Die Vordergrund-App kann über die Aktivierungsereignisargumente auf diese zugreifen.

Gibt zurück

Ein ValueSet--Objekt, das ein Windows-Runtime-Objekt Ihrer Auswahl enthält, das von der Vordergrund-App an das VPN-Plug-In zurückgegeben wird und das Ergebnis der Vordergrundanforderung angibt.

Windows-Anforderungen

Gerätefamilie
Windows 11 (eingeführt in 10.0.22000.0)
API contract
Windows.Foundation.UniversalApiContract (eingeführt in v14.0)
App-Funktionen
networkingVpnProvider

Hinweise

Anmerkung

Das Aufrufen dieser API außerhalb der IVpnPlugin.Connect Methodenimplementierung in einem VPN-Plug-In schlägt fehl.

Die Verwendung des Vordergrundaktivierungsmechanismus erfordert die Behandlung der Aktivierung an mehreren Stellen.

In Ihrer IVpnPlugin.Connect-Methode rufen Sie ActivateForeground- mit dem richtigen paketrelativen Anwendungsbezeichner (PRAID) und einer ValueSet- auf, die alle Werte enthält, die Sie an Ihre Vordergrund-App senden möchten.

In der Vordergrund-App müssen Sie die Aktivierung abfangen. Die Vordergrund-App wird mit einem Windows.ApplicationModel.ActivationKind Wert von VpnForegroundaktiviert. Die Aktivierungsargumente sind vom Typ Windows.Networking.Vpn.VpnForegroundActivatedEventArgsund enthalten drei Felder.

  1. ProfileName (Zeichenfolge).
  2. SharedContext- (ValueSet-).
  3. ActivationOperation (Windows.Networking.Vpn.VpnForegroundActivationOperation.

Die Vordergrund-App kann dann die Benutzeroberfläche Ihrer App einrichten, um die erforderliche Autorisierung (oder die erforderlichen Daten) zu verarbeiten. Wenn Sie fertig sind, müssen Sie die Complete-Methode des ActivationOperation-aufrufen, wobei ein ValueSet- von Werten übergeben wird, die an den IVpnPlugin.Connect Aufruf zurückgegeben werden sollen.

Verwenden Sie zurück im IVpnPlugin.Connect Anruf den ValueSet von ActivateForeground zurückgegeben, um zu entscheiden, ob die Authentifizierung erfolgreich war, und behandeln Sie Fehler.

Gilt für: