Skip to main content

ref / out / in

权威:BYREFOPAQUE。特性级强制形态见 TsMarshalAs;少分配套路见 少 GC Marshal

双路径摘要

方向行为
C# → JSGetFunction / delegate 桥)ref / out / in 默认 Push OpaqueValue
JS → C#ref/out/in 关键字区分 Pop;能否写回看实参形态

写回规则(直觉)

JS 实参形态写回 C# byref
OpaqueValue(get/set_opaquevalue
同型 ByVal exotic(如 struct)✅(真 ref 语义)
number / string / 多数 ByObj❌(拷入临时槽)
let x = 5;
Demo.Increment(x); // 若形参为 ref int:裸 number 不写回,x 仍为 5

const p = new Point2D(1, 2);
Demo.Offset(p); // ref Point2D:字段可写回 p

类型不兼容 → throw Error('zts: …')。必选 byref 传 undefined(临时槽路径)通常 throw;需观察写回时传 ByVal exotic 或有效 Opaque。

Opaque 读写

C#→JS 拿到的 byref 槽位通常是 Opaque:

// 在同一次同步调用链内
const v = zts.get_opaquevalue(slot);
zts.set_opaquevalue(slot, newValue);

ref Point2D 等值类型形参,传入同型 ByVal exotic(如 new Point2D(1, 2))即可写回;无需额外 API。详见 值类型zts 标准库

warning

Opaque 不可跨异步边界 / 跨帧持久化当长期句柄用。需要 ByVal 门面时用 zts.to_user_data(见规范)。失效后访问 → throw Error('zts: invalid opaque parameter handle')

分类要点

元素类型 A可写回 JS 原值的典型路径
值类型(struct / enum)同型 ByVal exotic,或 Opaque
基元仅 Opaque;改 JS let 绑定 路径
string / 引用类型Opaque;临时槽路径下 C# 重新赋值 不反映到原 JS 绑定;原地改可变对象仍可见

与值类型章的关系

by-val struct 是 拷贝;要「改字段并反映到 C#」须对 ref 形参传入同型 ByVal exotic,或走 Opaque。见 值类型Struct Marshal

相关文档