次の方法で共有


XPS OM コレクション インターフェイスの操作

コレクション インターフェイスの一般的なメソッドを使用する方法について説明します。

内容

このセクションで説明するメソッドは、次の一覧に示されています。 すべてのコレクション インターフェイスでこれらの各メソッドがサポートされているわけではありません。また、一部のインターフェイスでは、このページで説明されていないメソッドもサポートされています。 特定のインターフェイスでサポートされているメソッドの一覧については、そのインターフェイスの説明を参照してください。

Append メソッド
GetAt メソッド
GetCount メソッド
InsertAt メソッド
RemoveAt メソッド
SetAt メソッド

参照

Append メソッド

オブジェクトをコレクションの末尾に追加します。

ジェネリック構文

HRESULT Append(
  [in]  Object *object
);

説明

次の図に示すように、このメソッドはコレクションの末尾にパラメーター リストで渡されるオブジェクトを追加します。

append がコレクションにエントリを追加する方法を示す図

GetAt メソッド

コレクション内の指定した場所からオブジェクトを取得します。

ジェネリック構文

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

説明

index で指定されたコレクションの場所に格納されているオブジェクトを、object によって参照される変数に書き込みます。 この操作では、コレクションの内容は変更されません。 このプロセスを説明する図を次に示します。

getat がコレクションからエントリを取得する方法を示す図

GetCount メソッド

コレクションに格納されているオブジェクトの数を取得します。

ジェネリック構文

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

説明

現在コレクションに格納されているオブジェクトの数を 、count によって参照される変数に書き込みます。 この操作では、コレクションの内容は変更されません。 このプロセスを説明する図を次に示します。

getcount がコレクション内のエントリの数を取得する方法を示す図

InsertAt メソッド

コレクションの指定した場所にオブジェクトを挿入します。

ジェネリック構文

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

説明

オブジェクトで渡される オブジェクト は、 index で指定された場所にあるコレクションに挿入されます。 新しい オブジェクトを挿入する前に、このメソッドは、インデックス位置を占有していたオブジェクトを 1 ずつ移動し、 index の後にあるすべてのインターフェイス ポインターを移動します。 このプロセスを説明する図を次に示します。

insertat がコレクションにエントリを追加する方法を示す図

RemoveAt メソッド

コレクション内の指定した場所から オブジェクトを削除します。

ジェネリック構文

HRESULT RemoveAt(
  [in]  UINT32 index
);

説明

このメソッドは、index で指定された場所から オブジェクトを解放し、 インデックスの後の各ポインターのインデックスを 1 ずつ減らしてコレクションを圧縮 します。 このプロセスを説明する図を次に示します。

removeat がコレクションからエントリを削除する方法を示す図

SetAt メソッド

コレクション内の指定した場所にある オブジェクトを置き換えます。

ジェネリック構文

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

説明

このメソッドは、最初に index によって参照される場所にある オブジェクトを解放し、そのオブジェクトを object で渡された オブジェクトに置き換えます。 このプロセスを説明する図を次に示します。

setat がコレクション内のエントリを置き換える方法を示す図

参照

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