Compartilhar via

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

  • Artigo

Gera um nome exclusivo que pode ser usado como uma chave de pesquisa por um recurso em um dicionário de recursos.

Sintaxe

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

Parâmetros

[in] type

O tipo de objeto IXpsOMShareable para o qual a chave de pesquisa é gerada.

[out, retval] key

A cadeia de caracteres de chave de pesquisa gerada por esse método.

Retornar valor

Se o método for bem-sucedido, ele retornará S_OK; caso contrário, ele retornará um código de erro HRESULT .

Código de retorno Descrição
S_OK
 O método foi bem-sucedido.
E_POINTER
 key é NULL.
E_INVALIDARG
 type refere-se a um tipo de objeto que não é reconhecido.

Comentários

Para ser exclusiva no dicionário, a cadeia de caracteres gerada por GenerateUnusedLookupKey consiste em uma cadeia de caracteres de prefixo baseada no tipo de objeto e é seguida por quatro caracteres alfanuméricos exclusivos.

A cadeia de caracteres de prefixo para cada tipo de objeto é mostrada na tabela a seguir.

Tipo de objeto Cadeia de caracteres de prefixo para este tipo de objeto
XPS_OBJECT_TYPE_CANVAS Tela_
XPS_OBJECT_TYPE_GEOMETRY Geometria_
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 Caminho_
XPS_OBJECT_TYPE_RADIAL_GRADIENT_BRUSH RGBrush_
XPS_OBJECT_TYPE_SOLID_COLOR_BRUSH SCBrush_
XPS_OBJECT_TYPE_VISUAL_BRUSH VBrush_
 
Observação  

Esse método retorna uma cadeia de caracteres de chave exclusiva dentro do contexto desta página. Não há garantia de que você retorne uma chave exclusiva em um recurso de dicionário remoto que pode ser usado por mais de uma página.

 
Esse método aloca a memória usada pela cadeia de caracteres retornada na chave. Se key não for NULL, use a função CoTaskMemFree para liberar a memória.

Requisitos

   
Cliente mínimo com suporte Windows 7, Windows Vista com SP2 e Atualização de Plataforma para Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 R2, Windows Server 2008 com SP2 e Platform Update para Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho xpsobjectmodel.h

Confira também

IXpsOMPage

Especificação de Papel XML

XPS_OBJECT_TYPE