使用 XPS OM 集合接口

介绍如何使用集合接口的常用方法。

目录

本部分中介绍的方法显示在下面的列表中。 并非所有集合接口都支持其中每一种方法,某些接口也支持本页未介绍的方法。 有关特定接口支持的方法列表,请参阅该接口的说明。

Append 方法
GetAt 方法
GetCount 方法
InsertAt 方法
RemoveAt 方法
SetAt 方法

另请参阅

Append 方法

将 对象追加到集合的末尾。

泛型语法

HRESULT Append(
  [in]  Object *object
);

描述

在集合结束时,此方法追加在参数列表中传递的对象,如下图所示。

显示追加如何将条目添加到集合的图

GetAt 方法

从集合中的指定位置获取 对象。

泛型语法

HRESULT GetAt(
  [in]           UINT32 index,
  [out, retval]  Object **object
);

描述

将存储在由 索引 指定的集合位置的对象写入 对象引用的变量。 此操作不会更改集合的内容。 下图演示了此过程。

显示 getat 如何从集合中检索条目的图

GetCount 方法

获取集合中存储的对象数。

泛型语法

HRESULT GetCount(
  [out, retval]  UINT32 *count
);

描述

将集合中当前存储的对象数写入 计数引用的变量中。 此操作不会更改集合的内容。 下图演示了此过程。

显示 getcount 如何获取集合中条目数的图

InsertAt 方法

在集合的指定位置插入对象。

泛型语法

HRESULT InsertAt(
  [in]  UINT32 index,
  [in]  Object *object
);

描述

对象 中传递的对象将插入到集合中,该位置由 索引指定。 在插入新 对象之前,此方法将以前占据 索引 位置的对象移动 1,并移动 索引后的所有接口指针。 下图演示了此过程。

显示 insertat 如何将条目添加到集合的图

RemoveAt 方法

从集合中的指定位置删除 对象。

泛型语法

HRESULT RemoveAt(
  [in]  UINT32 index
);

描述

此方法从 index 指定的位置释放对象,然后通过将索引后每个指针的索引减少 1 来压缩集合。 下图演示了此过程。

显示 removeat 如何从集合中删除条目的图

SetAt 方法

替换集合中指定位置的 对象。

泛型语法

HRESULT SetAt(
  [in]  UINT32 index,
  [in]  Object *object
);

描述

此方法首先在 索引引用的位置释放 对象,然后将该对象替换为在 对象中传递的对象。 下图演示了此过程。

显示 setat 如何替换集合中的条目的图

另请参阅

IXpsOMColorProfileResourceCollection
IXpsOMDashCollection
IXpsOMDocumentCollection
IXpsOMFontResourceCollection
IXpsOMGeometryFigureCollection
IXpsOMGradientStopCollection
IXpsOMImageResourceCollection
IXpsOMNameCollection
IXpsOMPageReferenceCollection
IXpsOMPartUriCollection
IXpsOMRemoteDictionaryResourceCollection
IXpsOMSignatureBlockResourceCollection
IXpsOMVisualCollection
IXpsSignatureBlockCollection
IXpsSignatureCollection
IXpsSignatureRequestCollection