Método IOleLink::GetSourceDisplayName (oleidl.h)

Artigo
03/01/2024

Recupera o nome de exibição da origem do link do objeto vinculado.

Sintaxe

HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

Parâmetros

[out] ppszDisplayName

Endereço de uma variável de ponteiro que recebe um ponteiro para o nome de exibição da origem do link. Se ocorrer um erro, ppszDisplayName será definido como NULL; caso contrário, a implementação deve usar IMalloc::Alloc para alocar a cadeia de caracteres retornada em ppszDisplayName e o chamador é responsável por chamar IMalloc::Free para liberá-la. Tanto o chamador quanto o chamado usam o alocador retornado por CoGetMalloc.

Retornar valor

Esse método retorna S_OK em caso de êxito. Outros valores retornados possíveis incluem o seguinte.

Código de retorno	Descrição
E_FAIL	Falha na operação.

A recuperação do nome de exibição requer a chamada dessas funções; Portanto, esse método pode retornar erros gerados por CreateBindCtx e IMoniker::GetDisplayName.

Comentários

Anotações aos Chamadores

Seu aplicativo de contêiner pode chamar IOleLink::GetSourceDisplayName para exibir a fonte atual de um link.

A origem atual de um link é exibida na caixa de diálogo Links . Se você usar a função OleUIEditLinks para exibir a caixa de diálogo Links , deverá implementar a interface IOleUILinkContainer . A caixa de diálogo chama suas implementações de IOleUILinkContainer::GetLinkSource para obter a cadeia de caracteres que deve ser exibida. Sua implementação desse método pode chamar IOleLink::GetSourceDisplayName.

Observações aos implementadores

A implementação do objeto vinculado de IOleLink::GetSourceDisplayName chama IOleLink::GetSourceMoniker para obter o moniker de origem do link e, em seguida, chama IMoniker::GetDisplayName para obter o nome de exibição desse moniker. Essa operação é potencialmente cara porque pode exigir a associação do moniker. Todos os monikers fornecidos pelo sistema podem retornar um nome de exibição sem associação, mas não há garantia de que outras implementações de moniker possam. Em vez de fazer chamadas repetidas para IOleLink::GetSourceDisplayName, seu aplicativo de contêiner pode armazenar em cache o nome e atualizá-lo sempre que a origem do link estiver associada.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	oleidl.h