Méthode IXpsOMPage ::GenerateUnusedLookupKey (xpsobjectmodel.h)

Article
12/22/2023

Génère un nom unique qui peut être utilisé comme clé de recherche par une ressource dans un dictionnaire de ressources.

Syntaxe

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

Paramètres

[in] type

Type d’objet IXpsOMShareable pour lequel la clé de recherche est générée.

[out, retval] key

Chaîne de clé de recherche générée par cette méthode.

Valeur retournée

Si la méthode réussit, elle retourne S_OK ; sinon, elle retourne un code d’erreur HRESULT .

Code de retour	Description
S_OK	S_OK
E_POINTER	la clé est NULL.
E_INVALIDARG	type fait référence à un type d’objet qui n’est pas reconnu.

Remarques

Pour être unique dans le dictionnaire, la chaîne générée par GenerateUnusedLookupKey se compose d’une chaîne de préfixe basée sur le type d’objet et suivie de quatre caractères alphanumériques uniques.

La chaîne de préfixe pour chaque type d’objet est indiquée dans le tableau suivant.

Type d’objet	Chaîne de préfixe pour ce type d’objet
XPS_OBJECT_TYPE_CANVAS	Toile_
XPS_OBJECT_TYPE_GEOMETRY	Géométrie_
XPS_OBJECT_TYPE_GLYPHS	Glyphes_
XPS_OBJECT_TYPE_IMAGE_BRUSH	IBrush_
XPS_OBJECT_TYPE_LINEAR_GRADIENT_BRUSH	LGBrush_
XPS_OBJECT_TYPE_MATRIX_TRANSFORM	MTransform_
XPS_OBJECT_TYPE_PATH	Chemin_
XPS_OBJECT_TYPE_RADIAL_GRADIENT_BRUSH	RGBrush_
XPS_OBJECT_TYPE_SOLID_COLOR_BRUSH	SCBrush_
XPS_OBJECT_TYPE_VISUAL_BRUSH	VBrush_

Remarque

Cette méthode retourne une chaîne de clé unique dans le contexte de cette page. Il n’est pas garanti de retourner une clé unique dans une ressource de dictionnaire distante qui pourrait être utilisée par plusieurs pages.

Cette méthode alloue la mémoire utilisée par la chaîne retournée dans la clé. Si la clé n’est pas NULL, utilisez la fonction CoTaskMemFree pour libérer la mémoire.

Configuration requise


Client minimal pris en charge	Windows 7, Windows Vista avec SP2 et Mise à jour de plateforme pour Windows Vista [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2008 R2, Windows Server 2008 avec SP2 et Platform Update pour Windows Server 2008 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	xpsobjectmodel.h

Voir aussi

IXpsOMPage

XML Paper Specification

XPS_OBJECT_TYPE

Partager via