winrt::com_ptr struct template (C++/WinRT)

Templat penunjuk cerdas COM yang dihitung referensi. com_ptr mewakili penunjuk ke jenis implementasi kelas antarmuka atau runtime yang ditentukan oleh parameter templat. Ini secara otomatis mengelola jumlah referensi untuk targetnya melalui penunjuk mentah privat.

Sintaks

template <typename T>
struct com_ptr

Parameter templat

typename T Antarmuka, atau jenis implementasi kelas runtime, penunjuk yang diwakili oleh com_ptr. Ini adalah jenis target penunjuk pintar.

Persyaratan

SDK minimum yang didukung: Windows SDK versi 10.0.17134.0 (Windows 10, versi 1803)

Namespace: winrt

Header: %WindowsSdkDir%Include<WindowsTargetPlatformVersion>\cppwinrt\winrt\base.h (disertakan secara default)

Alias jenis anggota

Nama alias Jenis
com_ptr::type Sinonim untuk representasi parameter templat yang ditentukan implementasi typename T .

Konstruktor

Konstruktor Deskripsi
konstruktor com_ptr::com_ptr Menginisialisasi instans baru struct com_ptr , secara opsional dengan salinan atau pemindahan data input.

Fungsi anggota

Fungsi Deskripsi
fungsi com_ptr::as Mengembalikan antarmuka yang diminta, jika didukung. Melempar jika tidak.
com_ptr::attach function Melampirkan ke pointer mentah yang memiliki referensi ke targetnya; referensi tambahan tidak ditambahkan.
com_ptr::capture function Memanggil fungsi atau metode tertentu (secara otomatis memanggil winrt::check_hresult di atasnya), dan menangkap pointer antarmuka yang keluaran dari fungsi atau metode sebagai void**.
fungsi com_ptr::copy_from Menyalin dari penunjuk lain. Mengurangi jumlah referensi pada antarmuka atau objek yang saat ini direferensikan, menyalin parameter pointer mentah, dan mulai mengelola masa pakai antarmuka atau objek yang diacu olehnya.
fungsi com_ptr::copy_to Menyalin ke penunjuk lain dari objek com_ptr . Menaikkan jumlah referensi pada antarmuka atau objek yang saat ini direferensikan, dan menyalin antarmuka atau alamat memori objek tersebut ke dalam parameter .
fungsi com_ptr::d etach Melepaskan dari antarmuka atau objek yang direferensikan tanpa mengurangi jumlah referensi, mungkin untuk mengembalikannya ke pemanggil.
com_ptr::get function Mengembalikan penunjuk mentah yang mendasar jika Anda perlu meneruskannya ke fungsi.
com_ptr::p ut Mengembalikan alamat penunjuk mentah yang mendasar; fungsi ini membantu Anda memanggil metode (seperti metode COM) yang mengembalikan referensi sebagai parameter keluar melalui pointer ke pointer.
fungsi com_ptr::p ut_void Mengembalikan alamat penunjuk mentah yang mendasar sebagai penunjuk ke penunjuk untuk membatalkan; fungsi ini membantu Anda memanggil metode (seperti metode COM) yang mengembalikan referensi sebagai parameter keluar melalui pointer ke pointer untuk membatalkan.
fungsi com_ptr::try_as Mengembalikan antarmuka yang diminta, jika didukung. Mengembalikan nullptr, atau false, jika tidak.
fungsi com_ptr::try_capture Versi com_ptr::capture yang tidak melemparkan kegagalan tetapi sebaliknya mengembalikan true jika berhasil atau false jika tidak.

Operator anggota

Operator Deskripsi
com_ptr::operator bool Memeriksa apakah penunjuk cerdas mereferensikan antarmuka atau objek atau tidak.
com_ptr::operator* (operator tidak langsung) Mengembalikan referensi ke target com_ptr sehingga Anda dapat meneruskannya ke fungsi yang mengharapkan referensi ke jenis target T.
com_ptr::operator= (operator penugasan) Menetapkan nilai ke objek com_ptr .
com_ptr::operator-> (operator panah) Untuk membeli akses ke antarmuka yang dirujuk atau metode objek, mengembalikan penunjuk mentah yang mendasar.

Fungsi gratis

Fungsi Deskripsi
attach_abi (Fungsi attach_abi) Melampirkan objek com_ptr ke pointer mentah yang memiliki referensi ke targetnya; referensi tambahan tidak ditambahkan.
detach_abi (Fungsi detach_abi) Melepaskan objek com_ptr dari antarmuka mentahnya tanpa mengurangi jumlah referensi, mungkin untuk mengembalikannya ke penelepon.
fungsi pertukaran Tukar konten dua parameter com_ptr sehingga menunjuk satu sama lain.

Operator gratis

Fungsi Deskripsi
operator!= (operator ketidaksamaan) Mengembalikan nilai yang menunjukkan apakah dua parameter merujuk ke target yang berbeda.
operator< (operator kurang dari) Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi lebih awal dalam memori daripada parameter kedua.
operator<= (operator kurang dari atau sama dengan) Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi lebih awal dalam memori daripada, atau di lokasi yang sama dengan parameter kedua.
operator== (operator kesetaraan) Mengembalikan nilai yang menunjukkan apakah dua parameter merujuk ke antarmuka dan/atau objek yang sama.
operator> (operator lebih besar dari) Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi nanti dalam memori daripada parameter kedua.
operator>= (operator lebih besar dari atau sama dengan) Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi nanti dalam memori daripada, atau di lokasi yang sama dengan parameter kedua.

konstruktor com_ptr::com_ptr

Menginisialisasi instans baru struct com_ptr , secara opsional dengan salinan atau pemindahan data input.

Sintaks

com_ptr(winrt::com_ptr const& other) noexcept;
com_ptr(std::nullptr_t = nullptr) noexcept;
template <typename U> com_ptr(winrt::com_ptr<U> const& other) noexcept;
template <typename U> com_ptr(winrt::com_ptr<U>&& other) noexcept;

Parameter templat

typename U Jenis target yang ditujukan oleh penunjuk cerdas input.

Parameter

otherCom_ptr lain yang menginisialisasi objek com_ptr. T parameter harus dapat dikonversi ke T objek com_ptr.

fungsi com_ptr::as

Mengembalikan antarmuka yang diminta, jika didukung. Melempar jika tidak. Fungsi ini berguna jika Anda ingin mengkueri antarmuka yang tidak perlu Anda teruskan kembali ke pemanggil Anda.

Untuk contoh kode, lihat bagian Membuat instans dan mengembalikan jenis dan antarmuka yang diproyeksikan, dan bagian lain dalam topik tersebut.

Sintaks

template <typename To> auto as() const;
template <typename To> void as(To& to) const;

Parameter templat

typename To Jenis antarmuka yang diminta.

Parameter

to Referensi ke nilai untuk menerima antarmuka yang diminta.

Mengembalikan nilai

com_ptr mereferensikan antarmuka yang diminta, atau penunjuk cerdas yang diketik dengan kuat untuk antarmuka yang diminta (baik dinyatakan oleh C++/WinRT atau oleh pihak ketiga).

com_ptr::attach function

Melampirkan ke pointer mentah yang memiliki referensi ke targetnya; referensi tambahan tidak ditambahkan. Jika diperlukan, Anda dapat menggunakan fungsi ini untuk menggabungkan referensi.

Sintaks

void attach(T* value) noexcept;

Parameter

value Pointer mentah yang memiliki referensi ke targetnya.

fungsi com_ptr::capture

Memanggil fungsi atau metode tertentu (secara otomatis memanggil winrt::check_hresult di atasnya), dan menangkap penunjuk antarmuka yang dihasilkan dari fungsi atau metode sebagai void**.

Lihat juga templat fungsi winrt::capture.

Sintaks

template <typename F, typename...Args>
void capture(F function, Args&&...args);

template <typename O, typename M, typename...Args>
void capture(O* p, M method, Args&& ...args);

template <typename O, typename M, typename...Args>
void capture(winrt::com_ptr<O> const& object, M method, Args&&...args);

Parameter templat

typename F Jenis objek fungsi, seperti fungsi bebas, atau std::function.

typename O Jenis antarmuka.

typename M Jenis metode.

typename Args Jenis argumen nol atau lebih.

Parameter

function Objek fungsi jenis F.

p Penunjuk ke objek jenis O.

objectWinrt::com_ptr jenis O.

method Metode (diimplementasikan oleh O) dari jenis M.

args Argumen nol atau lebih dari jenis Args.

Keterangan

  • Kelebihan capture(F function, Args&&...args) beban memanggil objek fungsi.
  • Kelebihan capture(O* p, M method, Args&& ...args) beban memanggil metode pada penunjuk.
  • Kelebihan capture(winrt::com_ptr<O> const& object, M method, Args&&...args) beban memanggil metode pada objek .

Semua kelebihan beban melewati (ke pemanggilan) argumen tambahan apa pun yang Anda berikan. Semua kelebihan beban juga meneruskan dua argumen tambahan yang diperlukan pemanggilan tersebut—khususnya, REFIID (ID target winrt::com_ptr), dan kekosongan** (Alamat penunjuk ke target winrt::com_ptr).

Contoh

winrt::com_ptr<IDXGIAdapter> adapter
...
winrt::com_ptr<IDXGIFactory2> factory;
factory.capture(adapter, &IDXGIAdapter::GetParent);

fungsi com_ptr::copy_from

Menyalin dari penunjuk lain. Mengurangi jumlah referensi pada antarmuka atau objek yang saat ini direferensikan, menyalin parameter pointer mentah, dan mulai mengelola masa pakai antarmuka atau objek yang diacu olehnya.

Sintaks

void copy_from(T* other) noexcept;

Parameter

other Pointer mentah ke target yang masa pakainya harus dikelola oleh objek com_ptr .

fungsi com_ptr::copy_to

Menyalin ke penunjuk lain dari objek com_ptr . Menaikkan jumlah referensi pada antarmuka atau objek yang saat ini direferensikan, dan menyalin alamat memori antarmuka atau objek tersebut ke dalam parameter. Fungsi ini memungkinkan Anda membagikan referensi ke antarmuka yang sama tanpa memanggil QueryInterface.

Sintaks

void copy_to(T** other) const noexcept;

Parameter

other Alamat pointer mentah; untuk menyalin penunjuk ke target objek com_ptr .

fungsi com_ptr::d etach

Melepaskan dari antarmuka atau objek yang direferensikan tanpa mengurangi jumlah referensi, mungkin untuk mengembalikannya ke pemanggil.

Sintaks

T* detach() noexcept;

Mengembalikan nilai

Penunjuk ke antarmuka atau objek yang dirujuk oleh objek com_ptr .

com_ptr::get function

Mengembalikan pointer mentah yang mendasar jika Anda perlu meneruskannya ke fungsi. Anda dapat memanggil AddRef, Release, atau QueryInterface pada pointer yang dikembalikan.

Sintaks

T* get() const noexcept;

Mengembalikan nilai

Penunjuk ke antarmuka atau objek yang dirujuk oleh objek com_ptr .

fungsi com_ptr::p ut

Mengembalikan alamat penunjuk mentah yang mendasar; fungsi ini membantu Anda memanggil metode (seperti metode COM) yang mengembalikan referensi sebagai parameter keluar melalui penunjuk ke penunjuk. Jika objek com_ptr sudah memiliki target, maka tetapkan nullptr ke objek com_ptr sebelum memanggil fungsi ini, jika tidak, fungsi akan menegaskan.

Sintaks

T** put() noexcept;

Mengembalikan nilai

Alamat penunjuk mentah yang mendasar.

fungsi com_ptr::p ut_void

Mengembalikan alamat penunjuk mentah yang mendasar sebagai penunjuk ke penunjuk untuk dibatalkan; fungsi ini membantu Anda memanggil metode (seperti metode COM) yang mengembalikan referensi sebagai parameter keluar melalui penunjuk ke pointer untuk dibatalkan. Jika objek com_ptr sudah memiliki target, maka tetapkan nullptr ke objek com_ptr sebelum memanggil fungsi ini, jika tidak, fungsi akan menegaskan.

Sintaks

void** put_void() noexcept;

Mengembalikan nilai

Alamat penunjuk mentah yang mendasar sebagai penunjuk ke penunjuk untuk dibatalkan.

fungsi com_ptr::try_as

Mengembalikan antarmuka yang diminta, jika didukung. Mengembalikan nullptr ( autooverload -returning), atau false ( booloverload -returning), jika tidak. Fungsi ini berguna jika Anda ingin mengkueri antarmuka yang tidak perlu Anda teruskan kembali ke pemanggil Anda.

Sintaks

template <typename To> auto try_as() const noexcept;
template <typename To> bool try_as(To& to) const noexcept;

Parameter templat

typename To Jenis antarmuka yang diminta.

Parameter

to Referensi ke nilai untuk menerima antarmuka yang diminta.

Mengembalikan nilai

com_ptr yang mereferensikan antarmuka yang diminta, atau penunjuk cerdas yang diketik dengan kuat untuk antarmuka yang diminta (baik dinyatakan oleh C++/WinRT atau oleh pihak ketiga), jika antarmuka yang diminta didukung, jika tidak nullptr (autokelebihan pengembalian), atau false (boolkelebihan beban yang dikembalikan).

fungsi com_ptr::try_capture

Versi com_ptr::capture yang tidak melemparkan kegagalan tetapi mengembalikan jika true berhasil atau false jika tidak.

Lihat juga templat fungsi winrt::try_capture.

com_ptr::operator bool

Memeriksa apakah penunjuk pintar mereferensikan antarmuka atau objek atau tidak. Jika penunjuk cerdas tidak mereferensikan antarmuka atau objek, maka secara logis null; jika tidak, secara logis tidak null.

Sintaks

explicit operator bool() const noexcept;

Mengembalikan nilai

true jika penunjuk cerdas mereferensikan antarmuka atau objek (secara logis tidak null), jika tidak false (secara logis null).

com_ptr::operator* (operator tidak langsung)

Mengembalikan referensi ke target com_ptr sehingga Anda dapat meneruskannya ke fungsi yang mengharapkan referensi ke jenis target T.

Sintaks

T& operator*() const noexcept;

Mengembalikan nilai

Referensi ke target com_ptr.

com_ptr::operator= (operator penugasan)

Menetapkan nilai ke objek com_ptr .

Sintaks

winrt::com_ptr& operator=(winrt::com_ptr const& other) noexcept;
template <typename U> winrt::com_ptr& operator=(winrt::com_ptr<U> const& other) noexcept;
template <typename U> winrt::com_ptr& operator=(winrt::com_ptr<U>&& other) noexcept;

Parameter templat

typename U Jenis yang ditujukkan oleh nilai yang ditetapkan.

Parameter

other Nilai com_ptr untuk ditetapkan ke objek com_ptr . T parameter harus dapat dikonversi ke T objek com_ptr.

Mengembalikan nilai

Referensi ke objek com_ptr .

com_ptr::operator-> (operator panah)

Untuk membeli akses ke antarmuka yang dirujuk atau metode objek, mengembalikan penunjuk mentah yang mendasar. Anda tidak boleh memanggil AddRef atau Rilis pada penunjuk yang dikembalikan, tetapi Anda dapat memanggil QueryInterface.

Sintaks

auto operator->() const noexcept;

Mengembalikan nilai

Penunjuk ke antarmuka atau objek yang dirujuk oleh objek com_ptr .

attach_abi (Fungsi attach_abi)

Melampirkan objek com_ptr ke pointer mentah yang memiliki referensi ke targetnya; referensi tambahan tidak ditambahkan. Jika diperlukan, Anda dapat menggunakan fungsi ini untuk menyaring referensi.

Sintaks

void attach_abi(winrt::com_ptr<T>& object, T* value) noexcept;

Parameter

object Objek com_ptr untuk dioperasikan.

value Pointer mentah yang memiliki referensi ke targetnya.

detach_abi (Fungsi detach_abi)

Melepaskan objek com_ptr dari antarmuka mentahnya tanpa mengurangi jumlah referensi, mungkin untuk mengembalikannya ke penelepon.

Sintaks

auto detach_abi(winrt::com_ptr<T>& object) noexcept;

Parameter

object Objek com_ptr untuk dioperasikan.

Mengembalikan nilai

Penunjuk ke antarmuka mentah yang dirujuk oleh objek com_ptr .

operator!= (operator ketidaksamaan)

Mengembalikan nilai yang menunjukkan apakah dua parameter merujuk ke target yang berbeda.

Sintaks

template <typename T> bool operator!=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
template <typename T> bool operator!=(winrt::com_ptr<T> const& left, std::nullptr_t) noexcept;
template <typename T> bool operator!=(std::nullptr_t, winrt::com_ptr<T> const& right) noexcept;

Parameter

leftright Nilai com_ptr yang alamat memori targetnya dibandingkan dengan parameter lainnya.

Mengembalikan nilai

true jika kedua parameter menunjuk ke target yang berbeda, jika tidak false.

operator< (operator kurang dari)

Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi lebih awal dalam memori daripada parameter kedua.

Sintaks

template <typename T> bool operator<(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;

Parameter

leftright Nilai com_ptr yang alamat memori targetnya dibandingkan dengan parameter lainnya.

Mengembalikan nilai

true jika alamat memori target parameter pertama kurang dari parameter kedua, jika tidak false.

operator<= (operator kurang dari atau sama dengan)

Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi lebih awal dalam memori daripada, atau di lokasi yang sama dengan parameter kedua.

Sintaks

template <typename T> bool operator<=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;

Parameter

leftright Nilai com_ptr yang alamat memori targetnya dibandingkan dengan parameter lainnya.

Mengembalikan nilai

true jika alamat memori target parameter pertama kurang dari atau sama dengan parameter kedua, jika tidak false.

operator== (operator kesetaraan)

Mengembalikan nilai yang menunjukkan apakah dua parameter merujuk ke antarmuka dan/atau objek yang sama.

Sintaks

template <typename T> bool operator==(winrt::com_ptr<T> const& left, std::nullptr_t) noexcept;
template <typename T> bool operator==(std::nullptr_t, winrt::com_ptr<T> const& right) noexcept;

Parameter

leftright Nilai com_ptr yang alamat memori targetnya dibandingkan dengan parameter lainnya.

Mengembalikan nilai

true jika kedua parameter menunjuk ke target yang sama, jika tidak false.

operator> (operator lebih besar dari)

Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi nanti dalam memori daripada parameter kedua.

Sintaks

template <typename T> bool operator>(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;

Parameter

leftright Nilai com_ptr yang alamat memori targetnya dibandingkan dengan parameter lainnya.

Mengembalikan nilai

true jika alamat memori target parameter pertama lebih besar dari parameter kedua, jika tidak false.

operator>= (operator lebih besar dari atau sama dengan)

Mengembalikan nilai yang menunjukkan apakah target parameter pertama terjadi nanti dalam memori daripada, atau di lokasi yang sama dengan parameter kedua.

Sintaks

template <typename T> bool operator>=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;

Parameter

leftright Nilai com_ptr yang alamat memori targetnya dibandingkan dengan parameter lainnya.

Mengembalikan nilai

true jika alamat memori target parameter pertama lebih besar dari atau sama dengan parameter kedua, jika tidak false.

fungsi pertukaran

Tukar konten dua parameter com_ptr sehingga menunjuk satu sama lain.

Sintaks

void swap(winrt::com_ptr& left, winrt::com_ptr& right) noexcept;

Parameter

leftright Nilai com_ptr yang penunjuknya saling bertukar dengan parameter lainnya.

Lihat juga