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

Метод IXpsOMPage::GenerateUnusedLookupKey (xpsobjectmodel.h)

  • Статья

Создает уникальное имя, которое может использоваться ресурсом в словаре ресурсов в качестве ключа подстановки.

Синтаксис

HRESULT GenerateUnusedLookupKey(
  [in]          XPS_OBJECT_TYPE type,
  [out, retval] LPWSTR          *key
);

Параметры

[in] type

Тип объекта IXpsOMShareable , для которого создается ключ подстановки.

[out, retval] key

Строка ключа подстановки, созданная этим методом.

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

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

Код возврата Описание
S_OK
 Метод выполнен успешно.
E_POINTER
 key имеет значение NULL.
E_INVALIDARG
 type ссылается на тип объекта, который не распознается.

Комментарии

Чтобы быть уникальной в словаре, строка, созданная GenerateUnusedLookupKey , состоит из строки префикса, основанной на типе объекта, за которой следуют четыре уникальных буквенно-цифровых символа.

Строка префикса для каждого типа объекта показана в следующей таблице.

Тип объекта Строка префикса для этого типа объекта
XPS_OBJECT_TYPE_CANVAS Холст_
XPS_OBJECT_TYPE_GEOMETRY Геометрии_
XPS_OBJECT_TYPE_GLYPHS Глифы_
XPS_OBJECT_TYPE_IMAGE_BRUSH IBrush_
XPS_OBJECT_TYPE_LINEAR_GRADIENT_BRUSH LGBrush_
XPS_OBJECT_TYPE_MATRIX_TRANSFORM MTransform_
XPS_OBJECT_TYPE_PATH Путь_
XPS_OBJECT_TYPE_RADIAL_GRADIENT_BRUSH RGBrush_
XPS_OBJECT_TYPE_SOLID_COLOR_BRUSH SCBrush_
XPS_OBJECT_TYPE_VISUAL_BRUSH VBrush_
 
Примечание  

Этот метод возвращает строку ключа, которая является уникальной в контексте этой страницы. Не гарантируется возврат ключа, уникального в удаленном ресурсе словаря, который может использоваться несколькими страницами.

 
Этот метод выделяет память, используемую строкой, возвращаемой в ключе. Если ключ не равен NULL, используйте функцию CoTaskMemFree , чтобы освободить память.

Требования

   
Минимальная версия клиента 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

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

IXpsOMPage

XPS

XPS_OBJECT_TYPE