最終更新日時(UTC): 2025年10月14日 05時41分25秒
Akira Takahashi が更新

履歴 編集

function template
<memory>

# std::out_ptr(C++23)

    namespace std {
      template<class Pointer = void, class Smart, class... Args>
      auto
        out_ptr(Smart& s, Args&&... args); // (1) C++23
      template<class Pointer = void, class Smart, class... Args>
      constexpr auto
        out_ptr(Smart& s, Args&&... args); // (1) C++26
    }

## 概要

2重ポインタ`T**`引数経由で新規確保リソースへのポインタを返すレガシーC関数に対して、出力されたポインタ値をスマートポインタ`s`に格納するアダプタ`out_ptr_t`を返すヘルパ関数。

C++標準スマートポインタ`std::shared_ptr`や`std::unique_ptr`を始め、互換インタフェースをもつ任意のスマートポインタ型`Smart`を取り扱える。

説明用の`P`型を次のように定義する :

- `is_void_v<Pointer>`が`false`ならば`Pointer`
- そうでなければ、`Smart::pointer`が有効な型名であれば`Smart::pointer`
- そうでなければ、`Smart::element_type*`が有効な型名であれば`Smart::element_type*`
- そうでなければ、`pointer_traits<Smart>::element_type*`

## 戻り値

`out_ptr_t<Smart, P, Args&&...>(s, std::forward<Args>(args)...)`

## 例

### P1132R8引用

    // Legacy C APIs
    error_num c_api_create_handle(int seed_value, int** p_handle);
    void c_api_delete_handle(int* handle);

    // C++ program
    #include <memory>

    struct resource_deleter {
      void operator()(int* handle) {
        c_api_delete_handle(handle);
      }
    };

    int main() {
      std::unique_ptr<int, resource_deleter> resource(nullptr);
      error_num err = c_api_create_handle(
        24, std::out_ptr(resource)
      );
      if (err == C_API_ERROR_CONDITION) {
        // handle errors
      }
      // resource.get() the out-value from the C API function
    }

## バージョン

### 言語

- C++23

### 処理系

- Clang: ??
- GCC: ??
- ICC: ??
- Visual C++: ??

## 関連項目

- `out_ptr_t`
- `shared_ptr`
- `unique_ptr`

## 参照

- P1132R8 out_ptr - a scalable output pointer abstraction
- P3037R6 `constexpr std::shared_ptr` and friends