[out, retval]について

Question

VC++?COM?のコードを読んでいて、[out, retval]について疑問を感じたのですが、
調べても良い情報源にたどりつけなかったため、こちらで質問させていただきます。

[in]が通常の引数、outやretvalが出力引数を意味すると思っているのですが、
[out, retval]と記述されると、なんだか気持ち悪く感じてしまいます。
どちらも同じことを意味するのではないのでしょうか？

[retval]はなさそうですが、[out]はあるようですね。
そうとなると、[out]と[out, retval]は何が異なるのでしょうか。
copilotによると、出力と戻り値とのことですが、私はどちらも同じものと認識しています。

ご存じであれば、ご教授よろしくお願いいたします。

追記

https://learn.microsoft.com/ja-jp/cpp/windows/attributes/retval?view=msvc-170
retval は、関数の宣言の最後の引数に指定する必要があります。
とありました。

出力引数を2つ以上設定するときは、一つ目は[out]、二つ目は[out, retval]ということですかね。

Answer 1

C++ だけを考えているときは retval はあまり意味がありません。

通常は COM は様々な言語から利用可能なように配慮されており、 IDL 形式で書かれたインターフェイスから各言語へのバインディングを自動生成したりします。 そのとき retval でマークされた引数はそれぞれの言語で「返却値として返されたかのように」振る舞うという仕組みになっています。

つまり、たとえば

foo([in] data, [out] size, [out, retval] res); 

というような記述があれば、 VB や JScript からは

var sz;
var res = FooObj.foo("new_item", sz);

といったような要領で使えて、 res は (実装内部の) 実体としては引数でやり取りするけれど使うときは返却値のように使えるということなんです。

なので、当然ながら retval を使える引数はひとつの関数につきひとつだけです。 また、最後の引数でなければならないという制約もあるようです。

Comments

[OhaseO]

回答ありがとうございます。
理解が深まったように感じます。
COMについてはよく理解できていないのですが、COMではHRESULTを戻り値とするため、その代わりに？retvalを用意しているような認識で合っていますでしょうか。

[SaitoAtsushi]

その認識で良いと思います。

[OhaseO]

しっくりきました。
ありがとうございました！