Compartir a través de

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

  • Artículo

Genera un nombre único que se puede usar como clave de búsqueda por un recurso en un diccionario de recursos.

Sintaxis

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

Parámetros

[in] type

Tipo de objeto IXpsOMShareable para el que se genera la clave de búsqueda.

[out, retval] key

Cadena de clave de búsqueda generada por este método.

Valor devuelto

Si el método se realiza correctamente, devuelve S_OK; de lo contrario, devuelve un código de error HRESULT .

Código devuelto Descripción
S_OK
 El método se ha llevado a cabo de forma correcta.
E_POINTER
 key es NULL.
E_INVALIDARG
 type hace referencia a un tipo de objeto que no se reconoce.

Comentarios

Para ser único en el diccionario, la cadena generada por GenerateUnusedLookupKey consta de una cadena de prefijo basada en el tipo de objeto y va seguida de cuatro caracteres alfanuméricos únicos.

La cadena de prefijo para cada tipo de objeto se muestra en la tabla siguiente.

Tipo de objeto Cadena de prefijo para este tipo de objeto
XPS_OBJECT_TYPE_CANVAS Lona_
XPS_OBJECT_TYPE_GEOMETRY Geometría_
XPS_OBJECT_TYPE_GLYPHS Glifos_
XPS_OBJECT_TYPE_IMAGE_BRUSH IBrush_
XPS_OBJECT_TYPE_LINEAR_GRADIENT_BRUSH LGBrush_
XPS_OBJECT_TYPE_MATRIX_TRANSFORM MTransform_
XPS_OBJECT_TYPE_PATH Camino_
XPS_OBJECT_TYPE_RADIAL_GRADIENT_BRUSH RGBrush_
XPS_OBJECT_TYPE_SOLID_COLOR_BRUSH SCBrush_
XPS_OBJECT_TYPE_VISUAL_BRUSH VBrush_
 
Nota  

Este método devuelve una cadena de clave que es única en el contexto de esta página. No se garantiza que devuelva una clave que sea única en un recurso de diccionario remoto que podría usar más de una página.

 
Este método asigna la memoria usada por la cadena que se devuelve en clave. Si la clave no es NULL, use la función CoTaskMemFree para liberar la memoria.

Requisitos

   
Cliente mínimo compatible Windows 7, Windows Vista con SP2 y Platform Update para Windows Vista [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2008 R2, Windows Server 2008 con SP2 y Actualización de plataforma para Windows Server 2008 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado xpsobjectmodel.h

Consulte también

IXpsOMPage

XML Paper Specification

XPS_OBJECT_TYPE