参照カウントされた COM スマート ポインター テンプレート。 com_ptr は、template パラメーターで指定されたインターフェイスまたはランタイム クラスの実装タイプへのポインターを表します。 プライベート生ポインターを使用して、ターゲットの参照カウントを自動的に管理します。
構文
template <typename T>
struct com_ptr
テンプレート パラメーター
typename T インターフェイス (ランタイム クラスの実装型) で、ポインタが com_ptr で表されます。 これは、スマート ポインターのターゲットの型です。
必要条件
サポートされている最小 SDK: Windows SDK バージョン 10.0.17134.0 (Windows 10 バージョン 1803)
名前空間: winrt
ヘッダー: %WindowsSdkDir%Include< WindowsTargetPlatformVersion>\cppwinrt\winrt\base.h (既定で含まれています)
メンバー型のエイリアス
| エイリアス名 | 種類 |
|---|---|
| com_ptr::型 |
typename T テンプレート・パラメーターの実装定義表現のシノニム。 |
コンス トラクター
| コンストラクタ | 形容 |
|---|---|
| com_ptr::com_ptr コンストラクタ | com_ptr構造体の新しいインスタンスを初期化します。必要に応じて、入力データのコピーまたは移動を行います。 |
メンバー関数
| 機能 | 形容 |
|---|---|
| com_ptr::as 関数 | サポートされている場合は、要求されたインターフェイスを返します。 そうでない場合はスローします。 |
| com_ptr::attach 関数 | ターゲットへの参照を所有する生ポインターにアタッチします。追加の参照は追加されません。 |
| com_ptr::capture 関数 | 指定した関数またはメソッドを呼び出し (その関数に対して winrt::check_hresult を自動的に呼び出します)、関数またはメソッドから出力されるインターフェイス ポインターを void**としてキャプチャします。 |
| com_ptr::copy_from 関数 | 別のポインターからコピーします。 現在参照されているインターフェイスまたはオブジェクトの参照カウントをデクリメントし、生ポインター パラメーターをコピーして、そのパラメーターが指すインターフェイスまたはオブジェクトの有効期間の管理を開始します。 |
| com_ptr::copy_to 関数 | com_ptr オブジェクトから別のポインターにコピーします。 現在参照されているインターフェイスまたはオブジェクトの参照カウントをインクリメントし、そのインターフェイスまたはオブジェクトのメモリ アドレスをパラメーターにコピーします。 |
| com_ptr::d ETACH関数 | 参照カウントを減らさずに参照インターフェイスまたはオブジェクトからデタッチします。呼び出し元に返す場合があります。 |
| com_ptr::get 関数 | 関数に渡す必要がある場合は、基になる生ポインターを返します。 |
| com_ptr::p ut 関数 | 基になる生ポインターのアドレスを返します。この関数は、ポインターへのポインターを介して out パラメーターとして参照を返すメソッド (COM メソッドなど) を呼び出すのに役立ちます。 |
| com_ptr::p ut_void 関数 | 基になる生のポインタのアドレスを 、void へのポインタへのポインタとして返します。この関数は、 void へのポインターを介して参照を out パラメーターとして返すメソッド (COM メソッドなど) を呼び出すのに役立ちます。 |
| com_ptr::try_as 関数 | サポートされている場合は、要求されたインターフェイスを返します。
nullptr を返すか、そうでない場合は false を返します。 |
| com_ptr::try_capture関数 | 失敗時にスローせず、代わりに戻る バージョンの com_ptr::capture は、成功した場合は true を返し、そうでない場合は false を返します。 |
メンバー演算子
| 演算子 | 形容 |
|---|---|
| com_ptr::演算子 bool | スマート ポインターがインターフェイスまたはオブジェクトを参照しているかどうかを確認します。 |
| com_ptr::operator* (間接演算子) | com_ptrのターゲットへの参照を返し、ターゲット型 T への参照を期待する関数に渡すことができます。 |
| com_ptr::operator= (代入演算子) | com_ptr オブジェクトに値を割り当てます。 |
| com_ptr::operator-> (矢印演算子) | 参照先のインターフェイスまたはオブジェクトのメソッドにアクセスできるようにするには、基になる生ポインターを返します。 |
無料の関数
| 機能 | 形容 |
|---|---|
| attach_abi機能 | com_ptr オブジェクトを、そのターゲットへの参照を所有する生のポインターにアタッチします。追加の参照は追加されません。 |
| detach_abi機能 | 参照カウントをデクリメントせずに、 com_ptr オブジェクトを生のインターフェイスから切り離します。これは、おそらく呼び出し元に返すためです。 |
| スワップ機能 | 2 つの com_ptr パラメータの内容を入れ替えて、互いのターゲットを指すようにします。 |
Free 演算子
| 機能 | 形容 |
|---|---|
| operator!= (不等式演算子) | 2 つのパラメーターが異なるターゲットを参照しているかどうかを示す値を返します。 |
| operator< (より小さい演算子) | 最初のパラメーターのターゲットが 2 番目のパラメーターのターゲットよりもメモリ内で前に発生するかどうかを示す値を返します。 |
| operator<= (より小さいまたは等しい演算子) | 1 つ目のパラメーターのターゲットが、2 番目のパラメーターのターゲットよりも前のメモリ内で発生するか、または 2 番目のパラメーターと同じ場所にあるかを示す値を返します。 |
| operator== (等価演算子) | 2 つのパラメーターが同じインターフェイスまたはオブジェクトを参照しているかどうかを示す値を返します。 |
| 演算子> (より大きい演算子) | 1 番目のパラメーターのターゲットが、2 番目のパラメーターのターゲットよりも後でメモリ内で発生するかどうかを示す値を返します。 |
| operator>= (より大きいまたは等しい演算子) | 1 番目のパラメーターのターゲットが、2 番目のパラメーターのターゲットよりも後で発生するか、2 番目のパラメーターと同じ場所に配置されるかを示す値を返します。 |
com_ptr::com_ptr コンストラクター
com_ptr構造体の新しいインスタンスを初期化します。必要に応じて、入力データのコピーまたは移動を行います。
void*コンストラクターは T* を受け取り、所有権を引き継ぎます。
winrt::take_ownership_from_abi_t は、 このポインターを解放する責任が現在com_ptrに転送されていることを明示的にするマーカー型です。 refcount は正確に 1 である必要はありません。それは責任が移転されていると言っているだけです。
構文
com_ptr(winrt::com_ptr const& other) noexcept;
com_ptr(std::nullptr_t = nullptr) noexcept;
com_ptr(void* ptr, winrt::take_ownership_from_abi_t) noexcept;
template <typename U> com_ptr(winrt::com_ptr<U> const& other) noexcept;
template <typename U> com_ptr(winrt::com_ptr<U>&& other) noexcept;
テンプレート パラメーター
typename U 入力スマート ポインターが指すターゲットの種類。
パラメーター
other
com_ptr オブジェクトを初期化する別のcom_ptr。 パラメータの T は、 com_ptr オブジェクトの T に変換可能である必要があります。
com_ptr::as 関数
サポートされている場合は、要求されたインターフェイスを返します。 そうでない場合はスローします。 この関数は、呼び出し元に戻す必要のないインターフェイスを照会する場合に便利です。
コード例については、「 射影された型とインターフェイスのインスタンス化と返却」のセクションと、そのトピックの他のセクションを参照してください。
構文
template <typename To> auto as() const;
template <typename To> void as(To& to) const;
テンプレート パラメーター
typename To 要求されたインターフェイスの種類。
パラメーター
to 要求されたインターフェイスを受け取る値への参照。
戻り値
要求されたインターフェイスを参照する com_ptr 、または要求されたインターフェイスの厳密に型指定されたスマート ポインター (C++/WinRT またはサード パーティによって宣言された)。
com_ptr::attach 関数
ターゲットへの参照を所有する生ポインターにアタッチします。追加の参照は追加されません。 必要に応じて、この関数を使用して参照を結合できます。
構文
void attach(T* value) noexcept;
パラメーター
value ターゲットへの参照を所有する生ポインター。
com_ptr::capture 関数
指定した関数またはメソッドを呼び出し (その関数に対して winrt::check_hresult を自動的に呼び出します)、関数またはメソッドから出力されるインターフェイス ポインターを void**としてキャプチャします。
winrt::capture 関数テンプレートも参照してください。
構文
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);
テンプレート パラメーター
typename F 関数オブジェクト型 (free 関数や std::function など)。
typename O インターフェイスの種類。
typename M メソッドの種類。
typename Args 0 個以上の引数の型。
パラメーター
function
F 型の関数オブジェクト。
p
O 型のオブジェクトへのポインター。
object
O 型の winrt::com_ptr。
method
M型のメソッド(Oによって実装されます)。
args
Args 型の 0 個以上の引数。
備考
-
capture(F function, Args&&...args)オーバーロードは、関数オブジェクトを呼び出します。 -
capture(O* p, M method, Args&& ...args)オーバーロードは、ポインターのメソッドを呼び出します。 -
capture(winrt::com_ptr<O> const& object, M method, Args&&...args)オーバーロードは、オブジェクトに対するメソッドを呼び出します。
すべてのオーバーロードは、指定した追加の引数を (呼び出し側に) 渡します。 すべてのオーバーロードは、このような呼び出しに必要な 2 つの追加の引数 (具体的には、 REFIID ( winrt::com_ptr のターゲットの ID) と void** ( winrt::com_ptr のターゲットへのポインターのアドレス) も渡します。
例
winrt::com_ptr<IDXGIAdapter> adapter
...
winrt::com_ptr<IDXGIFactory2> factory;
factory.capture(adapter, &IDXGIAdapter::GetParent);
com_ptr::copy_from 関数
別のポインターからコピーします。 現在参照されているインターフェイスまたはオブジェクトの参照カウントをデクリメントし、生ポインター パラメーターをコピーして、そのパラメーターが指すインターフェイスまたはオブジェクトの有効期間の管理を開始します。
構文
void copy_from(T* other) noexcept;
パラメーター
other 有効期間を com_ptr オブジェクトで管理する必要があるターゲットへの未加工ポインター。
com_ptr::copy_to 関数
com_ptr オブジェクトから別のポインターにコピーします。 現在参照されているインターフェイスまたはオブジェクトの参照カウントをインクリメントし、そのインターフェイスまたはオブジェクトのメモリ アドレスをパラメーターにコピーします。 この関数を使用すると、 QueryInterface を呼び出さずに同じインターフェイスへの参照を渡すことができます。
構文
void copy_to(T** other) const noexcept;
パラメーター
other 生のポインタのアドレス。 com_ptr オブジェクトのターゲットへのポインターをコピーします。
com_ptr::d etach 関数
参照カウントを減らさずに参照インターフェイスまたはオブジェクトからデタッチします。呼び出し元に返す場合があります。
構文
T* detach() noexcept;
戻り値
com_ptr オブジェクトによって参照されるインターフェイスまたはオブジェクトへのポインター。
com_ptr::get 関数
関数に渡す必要がある場合は、基になる生ポインターを返します。 返されたポインターで AddRef、 Release、または QueryInterface を呼び出すことができます。
構文
T* get() const noexcept;
戻り値
com_ptr オブジェクトによって参照されるインターフェイスまたはオブジェクトへのポインター。
com_ptr::p ut 関数
値を入力する関数に渡される基になる生ポインターのアドレスを返します。この関数は、ポインターへのポインターを介して参照を out パラメーターとして返すメソッド (COM メソッドなど) を呼び出すのに役立ちます。
構文
T** put() noexcept;
戻り値
基になる生ポインターのアドレス。
com_ptr::p ut_void 関数
基になる未加工のポインターのアドレスを void へのポインターへのポインターとして返し、 void へのポインターを介して out パラメーターとして参照を返す関数 (COM メソッドなど) に渡します。
構文
void** put_void() noexcept;
戻り値
void へのポインターへのポインターとしての基になる生ポインターのアドレス。
com_ptr::try_as 関数
サポートされている場合は、要求されたインターフェイスを返します。
nullptr (auto を返すオーバーロード) を返すか、false (boolを返すオーバーロード) を返します (そうでない場合は)。 この関数は、呼び出し元に戻す必要のないインターフェイスを照会する場合に便利です。
構文
template <typename To> auto try_as() const noexcept;
template <typename To> bool try_as(To& to) const noexcept;
テンプレート パラメーター
typename To 要求されたインターフェイスの種類。
パラメーター
to 要求されたインターフェイスを受け取る値への参照。
戻り値
要求されたインターフェイスを参照する com_ptr 、または要求されたインターフェイス (C++/WinRT またはサード パーティによって宣言された) の厳密に型指定されたスマート ポインター (要求されたインターフェイスがサポートされている場合)、それ以外の場合は nullptr ( autoを返すオーバーロード)、または false ( boolを返すオーバーロード)。
com_ptr::try_capture 関数
失敗時にスローせず、代わりに戻る バージョンの com_ptr::capture は、成功した場合は true を返し、そうでない場合は false を返します。
winrt::try_capture 関数テンプレートも参照してください。
com_ptr::演算子 bool
スマート ポインターがインターフェイスまたはオブジェクトを参照しているかどうかを確認します。 スマート ポインターがインターフェイスまたはオブジェクトを参照していない場合は、論理的に null になります。それ以外の場合は、論理的に null ではありません。
構文
explicit operator bool() const noexcept;
戻り値
true スマート ポインターがインターフェイスまたはオブジェクトを参照している場合 (論理的に null ではない)、それ以外の場合は false (論理的に null)。
com_ptr::operator* (間接演算子)
com_ptrのターゲットへの参照を返し、ターゲット型 T への参照を期待する関数に渡すことができます。
構文
T& operator*() const noexcept;
戻り値
com_ptrのターゲットへの参照。
com_ptr::operator= (代入演算子)
com_ptr オブジェクトに値を割り当てます。
構文
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;
テンプレート パラメーター
typename U 代入される値が指す型。
パラメーター
other
com_ptr オブジェクトに割り当てるcom_ptr値。 パラメータの T は、 com_ptr オブジェクトの T に変換可能である必要があります。
戻り値
com_ptr オブジェクトへの参照。
com_ptr::operator-> (矢印演算子)
参照先のインターフェイスまたはオブジェクトのメソッドにアクセスできるようにするには、基になる生ポインターを返します。 返されたポインターで AddRef または Release を呼び出すことはできませんが、 QueryInterface を呼び出すことはできます。
構文
auto operator->() const noexcept;
戻り値
com_ptr オブジェクトによって参照されるインターフェイスまたはオブジェクトへのポインター。
attach_abi関数
com_ptr オブジェクトを、そのターゲットへの参照を所有する生のポインターにアタッチします。追加の参照は追加されません。 必要に応じて、この関数を使用して参照を結合できます。
構文
void attach_abi(winrt::com_ptr<T>& object, T* value) noexcept;
パラメーター
object 操作する com_ptr オブジェクト。
value ターゲットへの参照を所有する生ポインター。
detach_abi関数
参照カウントをデクリメントせずに、 com_ptr オブジェクトを生のインターフェイスから切り離します。これは、おそらく呼び出し元に返すためです。
構文
auto detach_abi(winrt::com_ptr<T>& object) noexcept;
パラメーター
object 操作する com_ptr オブジェクト。
戻り値
com_ptr オブジェクトによって参照される未加工のインターフェイスへのポインター。
operator!= (等しくない演算子)
2 つのパラメーターが異なるターゲットを参照しているかどうかを示す値を返します。
構文
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;
パラメーター
left
right ターゲットのメモリ アドレスを他のパラメータのメモリ アドレスと比較する com_ptr 値。
戻り値
true 2 つのパラメーターが異なるターゲットを指している場合は、それ以外の場合は false。
演算子< (より小さい演算子)
最初のパラメーターのターゲットが 2 番目のパラメーターのターゲットよりもメモリ内で前に発生するかどうかを示す値を返します。
構文
template <typename T> bool operator<(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
パラメーター
left
right ターゲットのメモリ アドレスを他のパラメータのメモリ アドレスと比較する com_ptr 値。
戻り値
true 最初のパラメータのターゲットのメモリアドレスが2番目のパラメータのメモリアドレスよりも小さい場合は、それ以外の場合は false。
operator<= (より小さいまたは等しい演算子)
1 つ目のパラメーターのターゲットが、2 番目のパラメーターのターゲットよりも前のメモリ内で発生するか、または 2 番目のパラメーターと同じ場所にあるかを示す値を返します。
構文
template <typename T> bool operator<=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
パラメーター
left
right ターゲットのメモリ アドレスを他のパラメータのメモリ アドレスと比較する com_ptr 値。
戻り値
true 最初のパラメーターのターゲットのメモリアドレスが2番目のパラメーターのメモリアドレス以下である場合、それ以外の場合は false。
operator== (等値演算子)
2 つのパラメーターが同じインターフェイスまたはオブジェクトを参照しているかどうかを示す値を返します。
構文
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;
パラメーター
left
right ターゲットのメモリ アドレスを他のパラメータのメモリ アドレスと比較する com_ptr 値。
戻り値
true 2 つのパラメーターが同じターゲットを指している場合は、それ以外の場合は false。
演算子> (より大きい演算子)
1 番目のパラメーターのターゲットが、2 番目のパラメーターのターゲットよりも後でメモリ内で発生するかどうかを示す値を返します。
構文
template <typename T> bool operator>(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
パラメーター
left
right ターゲットのメモリ アドレスを他のパラメータのメモリ アドレスと比較する com_ptr 値。
戻り値
true 最初のパラメータのターゲットのメモリアドレスが2番目のパラメータのメモリアドレスより大きい場合は、それ以外の場合は false。
operator>= (より大きいまたは等しい演算子)
1 番目のパラメーターのターゲットが、2 番目のパラメーターのターゲットよりも後で発生するか、2 番目のパラメーターと同じ場所に配置されるかを示す値を返します。
構文
template <typename T> bool operator>=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
パラメーター
left
right ターゲットのメモリ アドレスを他のパラメータのメモリ アドレスと比較する com_ptr 値。
戻り値
true 最初のパラメーターのターゲットのメモリアドレスが2番目のパラメーターのメモリアドレス以上の場合は、それ以外の場合は false。
swap 関数
2 つの com_ptr パラメータの内容を入れ替えて、互いのターゲットを指すようにします。
構文
void swap(winrt::com_ptr& left, winrt::com_ptr& right) noexcept;
パラメーター
left
right ポインタが他のパラメータのポインタと相互にスワップする com_ptr 値。