API Host ScriptEnumerator

ScriptEnumerator

由 ScriptObject 与 ScriptArray 枚举 API 返回的迭代器。

Enumerator returned by ScriptObject and ScriptArray enumeration APIs.

命名空间：AuroraScript.Runtime.Types。类型：class。

Namespace: AuroraScript.Runtime.Types. Kind: class.

返回 .NET Host API 参考

Back to .NET Host API Reference

用途

Purpose

ScriptEnumerator 是公开宿主类型。通过下方签名选择调用方式；对运行时对象、生命周期和异常，应由宿主在边界处明确处理。

Enumerator returned by ScriptObject and ScriptArray enumeration APIs.

简单示例

Simple Example

下面是 ScriptEnumerator 的最小使用方式。

A minimal use of ScriptEnumerator.

var values = new ScriptArray();
values.Push(ScriptDatum.FromNumber(42));

var iterator = values.GetEnumerator();
while (iterator.NextValue(out var item))
{
    Console.WriteLine(item.Number);
}

成员

Members

Constructor

签名

• ScriptEnumerator(ScriptArray array)
• ScriptEnumerator(ScriptDatum[] items)
• ScriptEnumerator(List<ScriptDatum> items)

创建 ScriptEnumerator 实例。

Use the member according to its public signature.

Parameters:

• array
  按签名提供的 ScriptArray 参数。

  The ScriptArray parameter required by the signature.

• items
  按签名提供的 ScriptDatum[] 参数。

  The ScriptDatum[] parameter required by the signature.

Returns

新建的 ScriptEnumerator 实例。

A new ScriptEnumerator instance.

调用示意

以下示例展示调用形状；将占位实例和参数替换为宿主中的实际值。

The example shows the call shape; replace placeholder instances and arguments with actual host values.

var value = new ScriptEnumerator(/* 参数 */);

static ScriptEnumerator FromString(string value)

调用 FromString 完成其公开操作。

Use the member according to its public signature.

Parameters:

• value
  要处理、保存或转换的值。

  Value to process, store, or convert.

Returns

返回 ScriptEnumerator。

Returns ScriptEnumerator.

调用示意

以下示例展示调用形状；将占位实例和参数替换为宿主中的实际值。

The example shows the call shape; replace placeholder instances and arguments with actual host values.

var result = ScriptEnumerator.FromString(/* value */);

ScriptDatum Value()

调用 Value 完成其公开操作。

Use the member according to its public signature.

Parameters:

• 无。

  None.

Returns

返回 ScriptDatum。

Returns ScriptDatum.

调用示意

以下示例展示调用形状；将占位实例和参数替换为宿主中的实际值。

The example shows the call shape; replace placeholder instances and arguments with actual host values.

ScriptEnumerator value = /* 从宿主 API 获取实例 */;
var result = value.Value();

bool NextValue(out ScriptDatum data)

调用 NextValue 完成其公开操作。

Use the member according to its public signature.

Parameters:

• data
  按签名提供的 ScriptDatum 参数。

  The ScriptDatum parameter required by the signature.

Returns

返回 bool。

Returns bool.

调用示意

以下示例展示调用形状；将占位实例和参数替换为宿主中的实际值。

The example shows the call shape; replace placeholder instances and arguments with actual host values.

ScriptEnumerator value = /* 从宿主 API 获取实例 */;
var result = value.NextValue(/* data */);

bool HasValue()

调用 HasValue 完成其公开操作。

Use the member according to its public signature.

Parameters:

• 无。

  None.

Returns

返回 bool。

Returns bool.

调用示意

以下示例展示调用形状；将占位实例和参数替换为宿主中的实际值。

The example shows the call shape; replace placeholder instances and arguments with actual host values.

ScriptEnumerator value = /* 从宿主 API 获取实例 */;
var result = value.HasValue();

void Next()

调用 Next 完成其公开操作。

Use the member according to its public signature.

Parameters:

• 无。

  None.

Returns

无。

None.

调用示意

以下示例展示调用形状；将占位实例和参数替换为宿主中的实际值。

The example shows the call shape; replace placeholder instances and arguments with actual host values.

ScriptEnumerator value = /* 从宿主 API 获取实例 */;
value.Next();

void Reset()

调用 Reset 完成其公开操作。

Use the member according to its public signature.

Parameters:

• 无。

  None.

Returns

无。

None.

调用示意

以下示例展示调用形状；将占位实例和参数替换为宿主中的实际值。

The example shows the call shape; replace placeholder instances and arguments with actual host values.

ScriptEnumerator value = /* 从宿主 API 获取实例 */;
value.Reset();