Compartilhar via


Método IXpsOMDictionary::InsertAt (xpsobjectmodel.h)

Insere uma interface IXpsOMShareable em um local especificado no dicionário e define a chave para identificar a interface.

Sintaxe

HRESULT InsertAt(
  [in] UINT32          index,
  [in] LPCWSTR         key,
  [in] IXpsOMShareable *entry
);

Parâmetros

[in] index

O índice baseado em zero no dicionário em que a interface IXpsOMShareable deve ser inserida.

[in] key

A chave a ser usada para identificar a interface IXpsOMShareable no dicionário.

A cadeia de caracteres referenciada por chave deve ser exclusiva no dicionário.

[in] entry

O ponteiro da interface IXpsOMShareable a ser inserido no local especificado pelo índice.

Um dicionário não pode conter ponteiros de interface duplicados. Esse parâmetro deve conter um ponteiro de interface que ainda não esteja no dicionário.

Retornar valor

O método retorna um HRESULT. Os valores possíveis incluem, mas não se limitam, aqueles na tabela a seguir. Para obter informações sobre valores retornados da API de documento XPS que não estão listados nesta tabela, consulte Erros de documento XPS.

Código de retorno Descrição
S_OK
O método foi bem-sucedido.
XPS_E_NO_CUSTOM_OBJECTS
A entrada não aponta para uma implementação de interface reconhecida. Não há suporte para a implementação personalizada de interfaces da API de Documento XPS.

Comentários

Os ponteiros de interface armazenados no dicionário geralmente serão ponteiros para interfaces, como IXpsOMBrush e IXpsOMVisual, que são derivadas da interface IXpsOMShareable . Para determinar o tipo de interface, chame o método IXpsOMShareable::GetType .

No local especificado pelo índice, esse método insere o ponteiro da interface IXpsOMShareable e define a chave; o ponteiro e a chave da interface são passados em valor e chave, respectivamente. Antes que o valor e a chave sejam inseridos, o ponteiro da interface e a chave neste e em todos os locais subsequentes são movidos para cima por um índice.

A figura a seguir ilustra como o dicionário é alterado pelo método InsertAt .

Uma figura que mostra como InsertAt adiciona uma entrada ao dicionário

Requisitos

Requisito Valor
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

IXpsOMDictionary

IXpsOMShareable

Especificação de Papel XML

Erros de documento XPS