winrt::event-Strukturvorlage (C++/WinRT)
Ein Typ, mit dem Sie ein Ereignis eines angegebenen Stellvertretungstyps deklarieren und implementieren können. Abonnenten übergeben ihre Ereignisbehandlungsstellvertretungen an ein Ereignis; das Ereignis registriert diese Stellvertretungen in einer Auflistung; Wenn es ausgelöst wird, ruft das Ereignis seine registrierten Stellvertretungen wiederum auf, damit Abonnenten das Ereignis behandeln können. Weitere Informationen zum Erstellen von Ereignissen und Codebeispielen finden Sie unter Autorereignisse in C++/WinRT.
Wenn Sie Ereignisse intern für Ihr Projekt benötigen und nicht auf Windows-Runtime Typen beschränkt sind, verwenden Sie eventwinrt<::d elegate>. Weitere Informationen finden Sie unter Parameterisierte Stellvertretungen, einfache Signale und Rückrufe innerhalb eines Projekts.
Weitere Informationen zum Behandeln von Ereignissen und Codebeispielen finden Sie unter Behandeln von Ereignissen mithilfe von Stellvertretungen in C++/WinRT.
Syntax
template <typename Delegate>
struct event
Vorlagenparameter
typename Delegate
Der Typ des Stellvertretungstyps, der sich registrieren kann, um das Ereignis zu behandeln.
Anforderungen
Mindest unterstützte SDK: Windows SDK Version 10.0.17134.0 (Windows 10, Version 1803)
Namespace: winrt
Header: %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (standardmäßig enthalten)
Elementtyp-Aliase
Aliasname | Typ |
---|---|
ereignis::d elegate_type | Ein Synonym für den typename Delegate Vorlagenparameter. |
Konstruktoren
Konstruktor | BESCHREIBUNG |
---|---|
ereignis::ereigniskonstruktor | Initialisiert eine neue Instanz der Ereignisstruktur . |
Memberfunktionen
Funktion | BESCHREIBUNG |
---|---|
event::add function | Registriert einen Stellvertretung mit dem Ereignisobjekt . |
event::remove-Funktion | Widerruft die Registrierung eines Stellvertretungs aus dem Ereignisobjekt . |
Memberoperatoren
Operator | BESCHREIBUNG |
---|---|
ereignis::operator() (Funktionsaufrufoperator) | Ruft alle registrierten Stellvertretungen des Ereignisobjekts mit den angegebenen Argumenten auf. |
ereignis::operator bool | Überprüft, ob das Ereignisobjekt alle Stellvertretungen registriert hat. |
ereignis::ereigniskonstruktor
Initialisiert eine neue Instanz der Ereignisstruktur .
Syntax
event();
event::add function
Registriert einen Stellvertretung mit dem Ereignisobjekt .
Syntax
winrt::event_token add(Delegate const& delegate);
Parameter
delegate
Ein Stellvertretung, um sich mit dem Ereignisobjekt zu registrieren.
Rückgabewert
Ein Winrt::event_token , das anschließend zum Widerrufen der Registrierung des Stellvertretungs verwendet werden kann.
ereignis::operator() (Funktionsaufrufoperator)
Ruft alle registrierten Stellvertretungen des Ereignisobjekts mit den angegebenen Argumenten auf.
Syntax
template<typename... Arg>
void operator()(Arg const&... args)
Vorlagenparameter
typename... Arg
Ein variadisches Vorlagenparameterpaket mit den Typen der Parameter, die der Stellvertretung übergeben wird, wenn er aufgerufen wird.
Parameter
args
Eine Variable Argumentliste mit den Argumenten, die der Stellvertretung übergeben wird, wenn er aufgerufen wird.
ereignis::operator bool
Überprüft, ob das Ereignisobjekt alle Stellvertretungen registriert hat.
Syntax
explicit operator bool() const noexcept;
Rückgabewert
true
wenn das Ereignisobjekt über registrierte Stellvertretungen verfügt, andernfalls false
.
event::remove-Funktion
Widerruft die Registrierung eines Stellvertretungs aus dem Ereignisobjekt .
Syntax
void remove(winrt::event_token const token);
Parameter
token
Ein Winrt::event_token , der den Stellvertretung identifiziert, dessen Registrierung widerrufen werden soll.