winrt::event-Strukturvorlage (C++/WinRT)

Ein Typ, mit dem Sie ein Ereignis eines angegebenen Delegattyps deklarieren und implementieren können. Abonnenten übergeben ihre Ereignisbehandlungs-Delegaten an ein Ereignis. das -Ereignis registriert diese Delegaten in einer Auflistung. Wenn es dann ausgelöst wird, ruft das Ereignis wiederum seine registrierten Delegaten auf, damit Abonnenten das Ereignis behandeln können. Weitere Informationen zum Erstellen von Ereignissen und Codebeispielen finden Sie unter Erstellen von Ereignissen in C++/WinRT.

Wenn Sie Ereignisse benötigen, die für Ihr Projekt intern sind und nicht auf Windows-Runtime beschränkt sind, verwenden Sie das Ereignis <winrt::delegate> . Weitere Informationen finden Sie unter Parametrisierte Delegaten, einfache Signale und Rückrufe innerhalb eines Projekts.

Weitere Informationen zur Behandlung von Ereignissen und Codebeispiele finden Sie unter Behandeln von Ereignissen mit Delegaten in C++/WinRT.

Syntax

template <typename Delegate>
struct event

Vorlagenparameter

typename Delegate Der Delegattyp, der zum Behandeln des Ereignisses registriert werden kann.

Anforderungen

Mindestens unterstütztes SDK: Windows SDK Version 10.0.17134.0 (Windows 10, Version 1803)

Namespace: winrt

Header: %WindowsSdkDir%Include <WindowsTargetPlatformVersion> \cppwinrt\winrt\base.h (standardmäßig enthalten)

Membertypaliase

Aliasname type
event::d elegate_type Ein Synonym für den typename Delegate Vorlagenparameter.

Konstruktoren

Konstruktor BESCHREIBUNG
event::event-Konstruktor Initialisiert eine neue Instanz der Ereignisstruktur.

Memberfunktionen

Funktion Beschreibung
event::add-Funktion Registriert einen Delegaten beim Ereignisobjekt.
event::remove-Funktion Widerruft die Registrierung eines Delegaten für das Ereignisobjekt.

Memberoperatoren

Operator Beschreibung
event::operator() (Funktionsaufrufoperator) Ruft alle registrierten Delegaten des Ereignisobjekts mit den bereitgestellten Argumenten auf.
event::operator bool Überprüft, ob für das Ereignisobjekt Delegaten registriert sind.

event::event-Konstruktor

Initialisiert eine neue Instanz der Ereignisstruktur.

Syntax

event();

event::add-Funktion

Registriert einen Delegaten beim Ereignisobjekt.

Syntax

winrt::event_token add(Delegate const& delegate);

Parameter

delegate Ein Delegat, der beim Ereignisobjekt registriert werden soll.

Rückgabewert

Ein winrt::event_token, der anschließend verwendet werden kann, um die Registrierung des Delegaten zu widerrufen.

event::operator() (Funktionsaufrufoperator)

Ruft alle registrierten Delegaten des Ereignisobjekts mit den bereitgestellten Argumenten auf.

Syntax

template<typename... Arg>
void operator()(Arg const&... args)

Vorlagenparameter

typename... Arg Ein variadic-Vorlagenparameterpaket, das die Typen der Parameter enthält, die der Delegat beim Aufruf übergeben wird.

Parameter

args Eine Variablenargumentliste, die die Argumente enthält, die der Delegat beim Aufruf übergeben wird.

event::operator bool

Überprüft, ob für das Ereignisobjekt Delegaten registriert sind.

Syntax

explicit operator bool() const noexcept;

Rückgabewert

true , wenn das Ereignisobjekt über registrierte Delegaten verfügt, andernfalls false .

event::remove-Funktion

Widerruft die Registrierung eines Delegaten für das Ereignisobjekt.

Syntax

void remove(winrt::event_token const token);

Parameter

token Ein winrt::event_token, der den Delegaten identifiziert, dessen Registrierung widerrufen werden soll.

Weitere Informationen