IXpsOMDictionary::Append メソッド (xpsobjectmodel.h)

[アーティクル]
12/22/2023

IXpsOMShareable インターフェイスとそのキーをディクショナリの末尾に追加します。

構文

HRESULT Append(
  [in] LPCWSTR         key,
  [in] IXpsOMShareable *entry
);

パラメーター

[in] key

このエントリに使用するキー。

キーによって参照される文字列は、ディクショナリ内で一意である必要があります。

[in] entry

ディクショナリに追加される IXpsOMShareable インターフェイスへのポインター。

ディクショナリに重複するインターフェイスポインターを含めることはできません。このパラメーターには、ディクショナリにまだ存在しないインターフェイスポインターが含まれている必要があります。

戻り値

このメソッドは HRESULT を返します。使用可能な値には、次の表に含まれる値が含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメントエラー」を参照してください。

リターンコード	説明
S_OK	メソッドが成功しました。
XPS_E_NO_CUSTOM_OBJECTS	エントリは、認識されたインターフェイスの実装を指していません。 XPS ドキュメント API インターフェイスのカスタム実装はサポートされていません。

注釈

ディクショナリに格納されているインターフェイスポインターは、通常、IXpsOMBrush や IXpsOMVisual などの IXpsOMShareable インターフェイスから派生したインターフェイスを指します。インターフェイスの種類を確認するには、 IXpsOMShareable::GetType メソッドを呼び出します。

次の図は、 Append メソッドによってディクショナリがどのように変更されるかを示しています。

要件


サポートされている最小のクライアント	Windows 7、Windows Vista SP2 と Windows Vista 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	xpsobjectmodel.h