IXpsOMDictionary::InsertAt メソッド (xpsobjectmodel.h)
ディクショナリ内の指定した場所に IXpsOMShareable インターフェイスを挿入し、インターフェイスを識別するキーを設定します。
構文
HRESULT InsertAt(
[in] UINT32 index,
[in] LPCWSTR key,
[in] IXpsOMShareable *entry
);
パラメーター
[in] index
IXpsOMShareable インターフェイスを挿入するディクショナリ内の 0 から始まるインデックス。
[in] key
ディクショナリ内の IXpsOMShareable インターフェイスを識別するために使用するキー。
キーによって参照される文字列は、ディクショナリ内で一意である必要があります。
[in] entry
インデックスで指定された場所に挿入される IXpsOMShareable インターフェイス ポインター。
ディクショナリに重複するインターフェイス ポインターを含めることはできません。 このパラメーターには、ディクショナリにまだ含まれていないインターフェイス ポインターが含まれている必要があります。
戻り値
このメソッドは HRESULT を返します。 使用可能な値には、次の表に示す値が含まれますが、これらに限定されません。 この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメント エラー」を参照してください。
| リターン コード | 説明 |
|---|---|
|
メソッドが成功しました。 |
|
エントリ は、認識されたインターフェイスの実装を指していません。 XPS ドキュメント API インターフェイスのカスタム実装はサポートされていません。 |
注釈
ディクショナリに格納されているインターフェイス ポインターは、通常、 IXpsOMBrush や IXpsOMVisual などのインターフェイスへのポインターであり、 IXpsOMShareable インターフェイスから派生します。 インターフェイスの種類を確認するには、 IXpsOMShareable::GetType メソッドを 呼び出します。
index で指定された場所に、このメソッドは IXpsOMShareable インターフェイス ポインターを挿入し、キーを設定します。インターフェイス ポインターとキーはそれぞれ値とキーで渡されます。 値とキーが挿入される前に、インターフェイス ポインターと、この位置のキーと後続のすべての場所が 1 つのインデックスによって上に移動されます。
次の図は、 InsertAt メソッドによってディクショナリがどのように変更されるかを示しています。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 7、Windows Vista SP2 および Windows Vista 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | xpsobjectmodel.h |