Método IOleUILinkContainerA::GetLinkSource (oledlg.h)

Artigo
03/05/2024

Recupera informações sobre um link que podem ser exibidas na caixa de diálogo Links .

Sintaxe

HRESULT GetLinkSource(
  [in]            DWORD dwLink,
  [out, optional] LPSTR *lplpszDisplayName,
  [out]           ULONG *lplenFileName,
  [out, optional] LPSTR *lplpszFullLinkType,
  [out, optional] LPSTR *lplpszShortLinkType,
  [out]           BOOL  *lpfSourceAvailable,
  [out]           BOOL  *lpfIsSelected
);

Parâmetros

[in] dwLink

Identificador exclusivo definido pelo contêiner para um único link. Consulte IOleUILinkContainer::GetNextLink.

[out, optional] lplpszDisplayName

Endereço de uma variável de ponteiro que recebe um ponteiro para a cadeia de caracteres de nome de exibição completa para a origem do link. A caixa de diálogo Links liberará essa cadeia de caracteres.

[out] lplenFileName

Ponteiro para o comprimento da parte do nome do arquivo à esquerda da cadeia de caracteres lplpszDisplayName . Se a origem do link não estiver armazenada em um arquivo, lplenFileName deverá ser 0. Para links OLE, chame IOleLink::GetSourceDisplayName.

[out, optional] lplpszFullLinkType

Endereço de uma variável de ponteiro que recebe um ponteiro para a cadeia de caracteres de tipo de link completo que é exibida na parte inferior da caixa de diálogo Links . O chamador aloca essa cadeia de caracteres. A caixa de diálogo Links liberará essa cadeia de caracteres. Para links OLE, esse deve ser o nome completo do Tipo de Usuário. Use IOleObject::GetUserType, especificando USERCLASSTYPE_FULL para dwFormOfType.

[out, optional] lplpszShortLinkType

Endereço de uma variável de ponteiro que recebe um ponteiro para a cadeia de caracteres de tipo de link curto que é exibida na caixa de listagem da caixa de diálogo Links . O chamador aloca essa cadeia de caracteres. A caixa de diálogo Links liberará essa cadeia de caracteres. Para links OLE, esse deve ser o nome de tipo de usuário curto. Use IOleObject::GetUserType, especificando USERCLASSTYPE_SHORT para dwFormOfType.

[out] lpfSourceAvailable

Ponteiro que retornará FALSE se souber que um link não está disponível, pois o link é para algum documento conhecido, mas indisponível. Determinadas opções, como Atualizar Agora, estão desabilitadas (esmaeecidos na interface do usuário) para esses casos.

[out] lpfIsSelected

Ponteiro para uma variável que informa à caixa de diálogo Editar Links que a entrada desse link deve ser selecionada na caixa de listagem de seleção múltipla da caixa de diálogo. OleUIEditLinks chama esse método pelo menos uma vez para que cada item seja colocado na lista de links. Se nenhum deles retornar TRUE, nenhum deles será selecionado quando a caixa de diálogo for exibida pela primeira vez. Se todos retornarem TRUE, todos serão exibidos. Ou seja, ele retornará TRUE se esse link atualmente fizer parte da seleção no documento subjacente, FALSE se não fizer isso. Todos os links selecionados no documento subjacente são selecionados na caixa de diálogo; dessa forma, o usuário pode selecionar um conjunto de links e usar a caixa de diálogo para atualizá-los ou alterar suas origens simultaneamente.

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_ACCESSDENIED	Permissões de acesso insuficientes.
E_FAIL	Falha na operação.
E_INVALIDARG	O identificador especificado é inválido.
E_OUTOFMEMORY	Não há memória suficiente disponível para esta operação.

Comentários

Anotações aos Chamadores

Chame esse método durante a inicialização da caixa de diálogo, depois de retornar da caixa de diálogo Alterar Fonte .

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	oledlg.h