C++/WinRT での IInspectable への値のボックス化およびボックス化解除

IInspectable インターフェイスは、Windows ランタイム (WinRT) 内のすべてのランタイム クラスのルート インターフェイスです。 これは、すべての COM インターフェイスとクラスのルートにある IUnknown に似た考えです。および System.Object は、すべての Common Type System クラスのルートにあります。

つまり、 IInspectable を必要とする関数は、任意のランタイム クラスのインスタンスを渡すことができます。 ただし、このような関数にスカラー値 (数値やテキスト値など) や配列を直接渡すことはできません。 代わりに、スカラー値または配列値を参照クラス オブジェクト内にラップする必要があります。 その折り返し処理は、値 のボックス化 と呼ばれます。

C++/WinRT は winrt::box_value 関数を提供し、スカラー値または配列値を受け取り、 IInspectable にボックス化された値を返します。 IInspectable をスカラー値または配列値にボックス化解除するには、winrt::unbox_value 関数があります。 IInspectable をスカラー値にボックス化解除するには、winrt::unbox_value_or 関数もあります。

値のボックス化の例

LaunchActivatedEventArgs::Arguments アクセサー関数は、スカラー値である winrt::hstring を返します。 その hstring 値をボックス化し、次のように IInspectable を期待する関数に渡すことができます。

void App::OnLaunched(LaunchActivatedEventArgs const& e)
{
    ...
    rootFrame.Navigate(winrt::xaml_typename<BlankApp1::MainPage>(), winrt::box_value(e.Arguments()));
    ...
}

XAML ボタンのコンテンツ プロパティを設定するには、 Button::Content ミューテーター関数を呼び出します。 content プロパティを文字列値に設定するには、このコードを使用します。

Button().Content(winrt::box_value(L"Clicked"));

最初に、 hstring 変換コンストラクターは、文字列リテラルを hstring に変換します。 その後、hstring を受け取る winrt::box_value のオーバーロードが呼び出されます。

IInspectable のアンボックスの例

IInspectable を想定する独自の関数では、winrt::unbox_value を使用してボックス化を解除できます。また、winrt::unbox_value_or を使用して既定値でボックス化を解除できます。 try_asを使用して std::optional にボックス化を解除することもできます。

void Unbox(winrt::Windows::Foundation::IInspectable const& object)
{
    hstring hstringValue = unbox_value<hstring>(object); // Throws if object is not a boxed string.
    hstringValue = unbox_value_or<hstring>(object, L"Default"); // Returns L"Default" if object is not a boxed string.
    float floatValue = unbox_value_or<float>(object, 0.f); // Returns 0.0 if object is not a boxed float.
    std::optional<int> optionalInt = object.try_as<int>(); // Returns std::nullopt if object is not a boxed int.
}

ボックス化された値の型を決定する

ボックス化された値を受け取り、それが含まれている型がわからない場合 (ボックス化を解除するには、その型を知る必要があります)、 その IPropertyValue インターフェイスのボックス化された値に対してクエリを実行し、その後で Type を呼び出すことができます。 コード例を次に示します。

WINRT_ASSERT はマクロ定義であり、 _ASSERTEに展開されます。

float pi = 3.14f;
auto piInspectable = winrt::box_value(pi);
auto piPropertyValue = piInspectable.as<winrt::Windows::Foundation::IPropertyValue>();
WINRT_ASSERT(piPropertyValue.Type() == winrt::Windows::Foundation::PropertyType::Single);

重要な API

• IInspectable インターフェイス
• winrt::box_value 関数テンプレート
• winrt::hstring 構造体
• winrt::unbox_value 関数テンプレート
• winrt::unbox_value_or 関数テンプレート