Метод IXpsOMDictionary::GetByKey (xpsobjectmodel.h)

Статья
03/05/2024

Возвращает указатель интерфейса IXpsOMShareable записи, содержащей указанный ключ.

Синтаксис

HRESULT GetByKey(
  [in]          LPCWSTR         key,
  [in]          IXpsOMShareable *beforeEntry,
  [out, retval] IXpsOMShareable **entry
);

Параметры

[in] key

Ключ записи, который необходимо найти в словаре.

[in] beforeEntry

Указатель интерфейса IXpsOMShareable на последнюю запись в словаре, в которой необходимо найти ключ. Если параметр beforeEntry имеет значение NULL или является указателем интерфейса на запись, которая отсутствует в словаре, будет выполнен поиск по всему словарю.

[out, retval] entry

Указатель интерфейса на запись словаря, ключ которой соответствует ключу.

Возвращаемое значение

Если метод завершается успешно, он возвращает S_OK; в противном случае возвращается код ошибки HRESULT .

Указатели интерфейса, хранящиеся в словаре, обычно указывают на интерфейсы, такие как IXpsOMBrush и IXpsOMVisual, которые являются производными от интерфейса IXpsOMShareable . Чтобы определить тип интерфейса, вызовите метод IXpsOMShareable::GetType .

Требования

Требование	Значение
Минимальная версия клиента	Windows 7, Windows Vista с пакетом обновления 2 (SP2) и обновлением платформы для Windows Vista [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2008 R2, Windows Server 2008 с пакетом обновления 2 (SP2) и Обновление платформы для Windows Server 2008 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	xpsobjectmodel.h

См. также раздел

IXpsOMDictionary

IXpsOMShareable

XPS

Поделиться через