winrt-Namespace (C++/WinRT)

Der winrt-Namespace bietet benutzerdefinierte Datentypen, die zu C++/WinRT gehören– die standard-, moderne C++17-Sprachprojektion für Windows-Runtime (WinRT)-APIs. Diese benutzerdefinierten Typen bieten geeignete Konvertierungen in und aus Standardtypen, sodass Sie weiterhin die Standard-C++-Sprachfeatures verwenden können, die Sie an die Verwendung gewöhnt sind, und den Quellcode, den Sie bereits haben.

Außerdem werden im winrt-Namespace Funktionen (zum Erstellen von Laufzeitklasseninstanzen, Boxing und Unboxing usw.), smarten Zeigern und anderen Einrichtungen bereitgestellt.

Typen im Winrt-Namespace

Typ BESCHREIBUNG
agile_ref-Strukturvorlage Ein Typ, der einen agilen Verweis auf ein C++/WinRT-Objekt oder eine Schnittstelle darstellt.
apartment_context-Struktur Erfasst den Threadkontext in einem Coroutine, damit es später wiederhergestellt werden kann.
array_view-Strukturvorlage Eine Ansicht oder Spanne einer zusammenhängenden Reihe von Werten.
auto_revoke_t-Markerstruktur Ein Markierungstyp, der zum Anfordern eines Ereignis-Widerrufs verwendet wird, wenn ein Stellvertretung zum Behandeln eines Ereignisses registriert wird.
clock-Struktur Ein Typ mit statischen Hilfsfunktionen zum Konvertieren einer Windows::Foundation::D ateTime (das heißt eine Std::chrono::time_point) in und von winrt::file_time und von time_t.
com-array-Strukturvorlage Eine Ansicht oder Spanne einer zusammenhängenden Reihe von Werten zum Übergeben an und von Windows-Runtime APIs.
com-ptr-Strukturvorlage Eine gezählte COM-smarte Zeigervorlage.
deferrable_event_args Ein Typ, den Sie zum Implementieren (erstellen) des zurückgesetzten Ereignismusters verwenden können.
delegate-Strukturvorlage Ein Typ, mit dem Sie einen benutzerdefinierten Stellvertretungstyp für Ihre eigenen Ereignisse deklarieren können.
event-Strukturvorlage Ein Typ, mit dem Sie ein Ereignis eines angegebenen Stellvertretungstyps deklarieren und implementieren können.
event_revoker-Strukturvorlage Wenn Sie eine Stellvertretung registrieren, können Sie einen Ereignis-Widerruf anfordern, mit dem Sie Ihre Stellvertretung automatisch oder manuell widerrufen können.
event_token-Struktur Ein Token, das beim Registrieren eines Ereignisbehandlungsstellvertretungs mit einem Ereignis zurückgegeben wird; kann verwendet werden, um die Registrierung derselben Stellvertretung zu widerrufen.
file_handle-Struktur Stellt ein Windows Dateihandpunktobjekt dar.
fire_and_forget-Struktur Verwenden Sie diesen Rückgabetyp, um Ihre Coroutine zu einem Feuer und Vergessen zu machen.
guid struct Stellt einen global eindeutigen Bezeichner (GUID) dar.
handle-Struktur Stellt ein Windows Handle-Objekt dar.
handle_type-Strukturvorlage Die Vorlage für winrt::handle und winrt::file_handle structs.
hstring-Struktur Eine sequenzielle Auflistung von UTF-16 Unicode-Zeichen, die eine Textzeichenfolge darstellen.
hresult_access_denied-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_ACCESSDENIED HRESULT-Fehlercode darstellt.
hresult_canceled-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen ERROR_CANCELLED HRESULT-Fehlercode darstellt.
hresult_changed_state-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_CHANGED_STATE HRESULT-Fehlercode darstellt.
hresult_class_not_available-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen CLASS_E_CLASSNOTAVAILABLE HRESULT-Fehlercode darstellt.
hresult_error-Struktur Ein Typ, der einen HRESULT-Fehlercode darstellt.
hresult_illegal_delegate_assignment-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_ILLEGAL_DELEGATE_ASSIGNMENT HRESULT-Fehlercode darstellt.
hresult_illegal_method_call-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_ILLEGAL_METHOD_CALL HRESULT-Fehlercode darstellt.
hresult_illegal_state_change-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_ILLEGAL_STATE_CHANGE HRESULT-Fehlercode darstellt.
hresult_invalid_argument-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_INVALIDARG HRESULT-Fehlercode darstellt.
hresult_no_interface-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_NOINTERFACE HRESULT-Fehlercode darstellt.
hresult_not_implemented-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_NOTIMPL HRESULT-Fehlercode darstellt.
hresult_out_of_bounds-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen E_BOUNDS HRESULT-Fehlercode darstellt.
hresult_wrong_thread-Struktur Ein von winrt::hresult_error abgeleiteter Typ, der einen RPC_E_WRONG_THREAD HRESULT-Fehlercode darstellt.
implements-Strukturvorlage Eine Basisstrukturvorlage, die eine oder mehrere Windows-Runtime Schnittstellen im Auftrag eines abgeleiteten Typs implementiert.
map_base-Strukturvorlage Eine Basisklasse, von der Sie abgeleitet werden sollen, die eine nicht beobachtete assoziative Auflistung darstellt.
map_view_base-Strukturvorlage Eine Basisklasse, von der Sie abgeleitet werden, die eine Ansicht einer zusammenhängenden Sequenz von Elementen in einer assoziativen Auflistung darstellt.
no_weak_ref-Markerstruktur Ein Markierungstyp, der zum Deaktivieren der schwachen Referenzunterstützung verwendet wird.
non_agile-Markerstruktur Ein Markertyp, der verwendet wird, um anzugeben, dass Ihr Typ nicht agile ist und daher die IAgileObject-Schnittstelle nicht implementiert.
observable_map_base-Strukturvorlage Eine Basisklasse, von der Sie abgeleitet werden sollen, die eine beobachtbare assoziative Auflistung darstellt.
observable_vector_base-Strukturvorlage Eine Basisklasse, von der Sie abgeleitet werden, die einen beobachteten Vektor darstellt.
static_lifetime-Markerstruktur Ein Markierungstyp, der verwendet wird, um eine Aktivierungsfabrik in der statischen Lebensdauer zu aktivieren.
vector_base-Strukturvorlage Eine Basisklasse, von der Sie abgeleitet werden, die eine nicht beobachtete allgemeine Auflistung darstellt, die als Vektor bezeichnet wird.
view_vector_base-Strukturvorlage Eine Basisklasse, von der Sie ihre eigene benutzerdefinierte Ansicht oder die Spanne einer zusammenhängenden Sequenz von Elementen in einer allgemeinen Auflistung ableiten können.
weak_ref-Strukturvorlage Ein Typ, der einen schwachen Verweis auf ein C++/WinRT-Objekt oder eine Schnittstelle darstellt.
Windows::Foundation::IUnknown-Struktur Jede C++/WinRT-Laufzeitklasse (ob eine Windows oder eine Laufzeitklasse von Drittanbietern) stammt aus winrt::Windows::Foundation::IUnknown.

Funktionen im Winrt-Namespace

Funktion BESCHREIBUNG
attach_abi-Funktion Eine Hilfsfunktion, die ein C++/WinRT-Objekt an einen Handle anfügen oder einem rohen Zeiger, der einen Verweis auf das Ziel besitzt.
box_value-Funktionsvorlage Eine Funktionsvorlage, die einen Skalar oder Arraywert innerhalb eines Referenzklasseobjekts umschließt, sodass es an eine Funktion übergeben werden kann, die IInspectable erwartet.
capture-Funktionsvorlage Eine Funktionsvorlage, die eine angegebene Funktion oder Methode aufruft, erfasst den resultierenden Schnittstellenzeiger und gibt ihn als winrt::com_ptr zurück.
check_bool-Funktionsvorlage Eine Hilfsfunktion, die überprüft, ob ein Wert falsch ist und wenn ja, ruft den letzten Fehlercodewert des Aufrufthreads ab, und löst eine Ausnahme mithilfe eines C++/WinRT-Objekts aus, das diesen Fehlercode darstellt.
check_hresult-Funktion Eine Hilfsfunktion, die überprüft, ob ein HRESULT-Code einen Fehler darstellt und wenn ja, eine Ausnahme mithilfe eines C++/WinRT-Objekts ausgelöst wird, das den Fehlercode darstellt.
check_nt-Funktionsvorlage Eine Hilfsfunktion, die überprüft, ob ein Code einen Fehler darstellt und falls ja, den NT-Statuswert des Fehlercodes einem HRESULT-Wert zugeordnet und eine Ausnahme mithilfe eines C++/WinRT-Objekts ausgelöst wird, das den Fehlercode darstellt.
check_pointer-Funktionsvorlage Eine Hilfsfunktion, die überprüft, ob ein Zeiger null ist und wenn dies der Fall ist, ruft den letzten Fehlercodewert des Aufrufthreads ab, und löst eine Ausnahme mithilfe eines C++/WinRT-Objekts aus, das diesen Fehlercode darstellt.
check_win32-Funktionsvorlage Eine Hilfsfunktion, die überprüft, ob ein Code einen Fehler darstellt und falls ja, den Systemfehlercode des Werts einem HRESULT-Wert zugeordnet und eine Ausnahme mithilfe eines C++/WinRT-Objekts ausgelöst wird, das den Fehlercode darstellt.
copy_from_abi-Funktion Eine Hilfsfunktion, die ein C++/WinRT-Objekt aus einem Handle oder aus einem rohen Zeiger kopiert.
copy_to_abi-Funktion Eine Hilfsfunktion, die einen Handle oder einen Zeiger aus einem C++/WinRT-Objekt kopiert.
create_instance-Funktionsvorlage Eine Funktionsvorlage, die ein einzelnes uninitialisiertes Objekt der Klasse erstellt, die einer angegebenen CLSID zugeordnet ist, und gibt sie als winrt::com_ptr zurück oder löst, wenn nicht erfolgreich.
detach_abi-Funktion Eine Hilfsfunktion, die ein C++/WinRT-Objekt aus seinem referenzierten Handle oder von seiner referenzierten Schnittstelle entfernt.
from_abi-Funktionsvorlage Eine Hilfsfunktion, die ein Objekt eines projektierten Typs enthält, ruft einen Zeiger auf die Implementierung ab.
get_abi Funktion Eine Hilfsfunktion, die einen Zeiger auf die zugrunde liegende IUnknown-Schnittstelle eines C++/WinRT-Objekts abruft.
get_activation_factory-Funktionsvorlage Eine Hilfsfunktion, die die Aktivierungsfabrik für einen angegebenen Windows-Runtime Klassentyp abruft.
get_cancellation_token-Funktion Verwenden Sie in einem Coroutine das von winrt::get_cancellation_token zurückgegebene Objekt, um nach oder auf eine Abbruchung zu reagieren.
get_class_nam-Funktion Eine Hilfsfunktion, die eine Zeichenfolge mit dem vollqualifizierten Typnamen einer angegebenen Windows-Runtime Klasse abruft.
get_interfaces-Funktion Eine Hilfsfunktion, die ein Array abruft, das die Bezeichner der Schnittstellen enthält, die von einem C++/WinRT-Objekt implementiert werden.
get_progress_token-Funktion Verwenden Sie in einem Coroutine das von winrt::get_progress_token zurückgegebene Objekt, um den Fortschritt zurück an einen Statushandler zu melden.
get_self-Funktionsvorlage Eine Hilfsfunktion, die ein Objekt eines projektierten Typs enthält, ruft einen Zeiger auf die Implementierung ab.
get_trust_level-Funktion Eine Hilfsfunktion, die die Vertrauensstufe eines C++/WinRT-Objekts abruft.
get_unknown-Funktion Eine Hilfsfunktion, die die Adresse der zugrunde liegenden unformatierten IUnknown-Schnittstelle eines Objekts eines projektierten Typs zurückgibt.
guid_of-Funktionsvorlage Eine Hilfsfunktionsvorlage, die die GUID einer Laufzeitklasse, coclass oder Schnittstelle abruft.
is_guid_of-Funktionsvorlage Eine Hilfsfunktionsvorlage, die bestimmt, ob die bereitgestellte GUID eines der angegebenen Laufzeitklassen, Coclasses oder Schnittstellen ist.
make-Funktionsvorlage Eine Factorymethode, die eine Instanz eines projizierten Typs oder einer Schnittstelle zurückgibt, wenn sie mit dem entsprechenden Implementierungstyp parameterisiert wird.
make_agile-Funktionsvorlage Eine Hilfsfunktion, die ein agile_ref-Objekt zurückgibt, das einen agilen Verweis auf ein C++/WinRT-Objekt oder eine Schnittstelle darstellt.
make_self-Funktionsvorlage Eine Factorymethode, die eine com_ptr an eine Instanz des Implementierungstyps für eine Laufzeitklasse zurückgibt.
make_weak-Funktionsvorlage Eine Hilfsfunktion, die ein weak_ref-Objekt zurückgibt, das einen schwachen Verweis auf ein C++/WinRT-Objekt oder eine Schnittstelle darstellt.
name_of-Funktionsvorlage Eine Hilfsfunktion, die eine Zeichenfolgenansicht abruft, die den vollqualifizierten Typnamen einer bestimmten Windows-Runtime Klasse enthält.
put_abi Funktion Eine Hilfsfunktion, die die Adresse des zugrunde liegenden IUnknown-Schnittstellenzeigers eines C++/WinRT-Objekts abruft, damit er auf einen anderen Wert festgelegt werden kann.
resume_after-Function Eine Hilfsfunktion, die Die Steuerung an den Aufrufer zurückgibt und dann die Ausführung auf einem Threadpoolthread nach einer Verzögerung fortgesetzt.
resume_background-Funktion Eine Hilfsfunktion, die Die Steuerung an den Aufrufer zurückgibt und die Ausführung auf einem Threadpoolthread fortgesetzt.
resume_foreground-Funktion Eine Hilfsfunktion – für die Verwendung in einem Coroutine – sie können co_await die Ausführung in einen bestimmten Vordergrundthread wechseln.
resume_on_signal Eine Funktion, die Sie verwenden können, um angehalten zu werden, bis ein Kernelereignis signalisiert wird.
single_threaded_map-Funktionsvorlage Eine Funktionsvorlage, die ein Objekt eines Typs erstellt und zurückgibt, der eine nicht beobachtete assoziative Auflistung (Map) implementiert. Das Objekt wird als IMap zurückgegeben.
single_threaded_observable_map-Funktionsvorlage Eine Funktionsvorlage, die ein Objekt eines Typs erstellt und zurückgibt, der eine beobachtbare assoziative Auflistung (Map) implementiert. Das Objekt wird als IObservableMap zurückgegeben.
single_threaded_observable_vector-Funktionsvorlage Eine Funktionsvorlage, die ein Objekt eines Typs erstellt und zurückgibt, der eine beobachtete Auflistung implementiert. Das Objekt wird als IObservableVector zurückgegeben.
single_threaded_vector-Funktionsvorlage Eine Funktionsvorlage, die ein Objekt eines Typs erstellt und zurückgibt, der eine allgemeine Auflistung implementiert. Das Objekt wird als IVector zurückgegeben.
swap-Funktion Eine Hilfsfunktion, die den Inhalt von zwei Werten austauscht.
throw_hresult-Funktion Eine Hilfsfunktion, die einen HRESULT-Fehlercode verwendet und eine Ausnahme mithilfe eines C++/WinRT-Objekts auslöst, das diesen Fehlercode darstellt.
throw_last_error-Funktion Eine Hilfsfunktion, die den letzten Fehlercodewert des Aufrufthreads abruft, und löst eine Ausnahme mithilfe eines C++/WinRT-Objekts aus, das diesen Fehlercode darstellt.
to_hresult-Funktion Eine Hilfsfunktion für die Verwendung in einem Fangblock, der die letzte Ausnahme in einen HRESULT-Fehlercode auslöst.
to_hstring-Funktion Eine Hilfsfunktion, die einen Eingabewert in einen winrt::hstring konvertiert, der die Zeichenfolgendarstellung des Werts enthält.
to_string Funktion Eine Hilfsfunktion, die eine eingabeweite Zeichenfolge in eine std::string konvertiert, die eine UTF-8 schmale Zeichenfolge enthält.
try_capture-Funktionsvorlage Eine Funktionsvorlage, die eine angegebene Funktion oder Methode aufruft, erfasst den Schnittstellenzeiger, der aus der Funktion oder Methode ausgegeben wird, und gibt ihn als winrt::com_ptr oder eine leere com_ptr zurück, wenn nicht erfolgreich.
try_create_instance-Funktionsvorlage Eine Funktionsvorlage, die ein einzelnes nicht initialisiertes Objekt der Klasse erstellt, die einer angegebenen CLSID zugeordnet ist, und gibt ihn als winrt::com_ptr oder ein leeres com_ptr zurück, wenn nicht erfolgreich.
try_get_activation_factory-Funktionsvorlage Eine Hilfsfunktion, die die Aktivierungsfabrik für einen angegebenen Windows-Runtime Klassentyp oder eine leere com_ptr abruft, falls nicht erfolgreich.
unbox_value-Funktionsvorlage Eine Funktionsvorlage, die einen Skalar- oder Arraywert innerhalb eines Referenzklasseobjekts ablöst (oder entboxt), sodass es in einer Funktion verarbeitet werden kann, die IInspectable erwartet.
unbox_value_or-Funktionsvorlage Eine Funktionsvorlage, die einen skalaren Wert aus einem Referenzklassenobjekt mit einem Fallbackwert entpackt (oder unboxes), damit er in einer Funktion verarbeitet werden kann, die IInspectable erwartet.
xaml_typename-Funktionsvorlage Eine Hilfsfunktion, die den Typnamen eines Windows-Runtime Typs zurückgibt, in Form eines Windows::UI::Xaml::Interop::TypeName-Objekts.

C++/WinRT-Funktionen, die Windows-Runtime APIs erweitern

Erweiterungsfunktionen sind in den C++/WinRT-Projektionstypen für bestimmte Windows-Runtime APIs vorhanden. Beispielsweise ist winrt::Windows::Foundation::IAsyncAction der C++/WinRT-Projektionstyp für IAsyncAction. Die Erweiterungsfunktionen sind nicht Teil der ABI-Oberfläche (Application Binary Interface) der tatsächlichen Windows-Runtime Typen, sodass sie nicht als Mitglieder der Windows-Runtime-APIs aufgeführt sind. Sie können sie jedoch innerhalb eines beliebigen C++/WinRT-Projekts aufrufen.

WinRT-API Funktionen BESCHREIBUNG
IAsyncAction abrufen, wait_for Siehe IAsyncAction C++/WinRT-Erweiterungsfunktionen
IAsyncActionWithProgress abrufen, wait_for Siehe IAsyncActionWithProgress C++/WinRT-Erweiterungsfunktionen
IAsyncOperation abrufen, wait_for Siehe IAsyncOperation C++/WinRT-Erweiterungsfunktionen
IAsyncOperationWithProgress abrufen, wait_for Siehe IAsyncOperationWithProgress C++/WinRT-Erweiterungsfunktionen
IBindableIterable anfang, ende Siehe IBindableIterable C++/WinRT-Erweiterungsfunktionen
IBindableIterator begin, end, operator++, operator++(int), operator* Siehe IBindableIterator C++/WinRT-Erweiterungsfunktionen
IBuffer data Siehe IBuffer C++/WinRT-Erweiterungsfunktionen
IIterable anfang, ende Siehe IIterable C++/WinRT-Erweiterungsfunktionen
IIterator operator++, operator++(int), operator* Siehe IIterator C++/WinRT-Erweiterungsfunktionen
IKeyValuePair Operator == Siehe IKeyValuePair C++/WinRT-Erweiterungsfunktionen
Imap begin, end, TryLookup, TryRemove Siehe IMap C++/WinRT-Erweiterungsfunktionen
IMapView begin, end, TryLookup Siehe IMapView C++/WinRT-Erweiterungsfunktionen
IMemoryBufferReference data Siehe IMemoryBufferReference C++/WinRT-Erweiterungsfunktionen
IVector anfang, ende Siehe IVector C++/WinRT-Erweiterungsfunktionen
IVectorView anfang, ende Siehe IVectorView C++/WinRT-Erweiterungsfunktionen

Andere Funktionen

Funktion BESCHREIBUNG
GetRuntimeClassName-Funktion Eine Memberfunktion (eines generierten Implementierungstyps), die eine Zeichenfolge zurückgibt, die den vollqualifizierten Typnamen der implementierten Windows-Runtime Klasse enthält.

Siehe auch

C++/WinRT