IXpsOMPage::GenerateUnusedLookupKey-Methode (xpsobjectmodel.h)

Artikel
12/22/2023

Generiert einen eindeutigen Namen, der von einer Ressource in einem Ressourcenwörterbuch als Nachschlageschlüssel verwendet werden kann.

Syntax

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

Parameter

[in] type

Der Typ des IXpsOMShareable-Objekts , für das der Nachschlageschlüssel generiert wird.

[out, retval] key

Die Suchschlüsselzeichenfolge, die von dieser Methode generiert wird.

Rückgabewert

Wenn die Methode erfolgreich ist, gibt sie S_OK zurück. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Rückgabecode	Beschreibung
S_OK	Die Methode wurde erfolgreich ausgeführt.
E_POINTER	key ist NULL.
E_INVALIDARG	type verweist auf einen Objekttyp, der nicht erkannt wird.

Hinweise

Um im Wörterbuch eindeutig zu sein, besteht die von GenerateUnusedLookupKey generierte Zeichenfolge aus einer Präfixzeichenfolge, die auf dem Objekttyp basiert, gefolgt von vier eindeutigen alphanumerischen Zeichen.

Die Präfixzeichenfolge für jeden Objekttyp wird in der folgenden Tabelle angezeigt.

Objekttyp	Präfixzeichenfolge für diesen Objekttyp
XPS_OBJECT_TYPE_CANVAS	Leinwand_
XPS_OBJECT_TYPE_GEOMETRY	Geometrie_
XPS_OBJECT_TYPE_GLYPHS	Symbole_
XPS_OBJECT_TYPE_IMAGE_BRUSH	IBrush_
XPS_OBJECT_TYPE_LINEAR_GRADIENT_BRUSH	LGBrush_
XPS_OBJECT_TYPE_MATRIX_TRANSFORM	MTransform_
XPS_OBJECT_TYPE_PATH	Pfad_
XPS_OBJECT_TYPE_RADIAL_GRADIENT_BRUSH	RGBrush_
XPS_OBJECT_TYPE_SOLID_COLOR_BRUSH	SCBrush_
XPS_OBJECT_TYPE_VISUAL_BRUSH	VBrush_

Hinweis

Diese Methode gibt eine Schlüsselzeichenfolge zurück, die im Kontext dieser Seite eindeutig ist. Es ist nicht garantiert, dass ein Schlüssel zurückgegeben wird, der in einer Remotewörterbuchressource eindeutig ist und von mehreren Seiten verwendet werden kann.

Diese Methode weist den Arbeitsspeicher zu, der von der Zeichenfolge verwendet wird, die als Schlüssel zurückgegeben wird. Wenn key nicht NULL ist, verwenden Sie die CoTaskMemFree-Funktion , um den Arbeitsspeicher freizugeben.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 7, Windows Vista mit SP2 und Plattformupdate für Windows Vista [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2, Windows Server 2008 mit SP2 und Plattformupdate für Windows Server 2008 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	xpsobjectmodel.h

Weitere Informationen

IXpsOMPage

XML Paper Specification

XPS_OBJECT_TYPE

Freigeben über