IOleLink::GetSourceDisplayName 方法 (oleidl.h)

检索链接对象的链接源的显示名称。

语法

HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

参数

[out] ppszDisplayName

接收指向链接源显示名称的指针的指针变量的地址。 如果发生错误, ppszDisplayName 设置为 NULL;否则,实现必须使用 IMalloc::Alloc 来分配 ppszDisplayName 中返回的字符串,并且调用方负责调用 IMalloc::Free 来释放它。 调用方和调用方都使用 CoGetMalloc 返回的分配器。

返回值

此方法在成功时返回S_OK。 其他可能的返回值包括以下内容。

返回代码 说明
E_FAIL
此操作失败。
 

检索显示名称需要调用这些函数;因此,此方法可能会返回 CreateBindCtxIMoniker::GetDisplayName 生成的错误。

注解

给调用方的说明

容器应用程序可以调用 IOleLink::GetSourceDisplayName 来显示链接的当前源。

链接的当前源显示在“ 链接 ”对话框中。 如果使用 OleUIEditLinks 函数显示 “链接 ”对话框,则必须实现 IOleUILinkContainer 接口。 该对话框调用 IOleUILinkContainer::GetLinkSource 的实现,以获取它应显示的字符串。 该方法的实现可以调用 IOleLink::GetSourceDisplayName

实施者说明

链接对象的 IOleLink::GetSourceDisplayName 实现调用 IOleLink::GetSourceMoniker 以获取链接源名字对象,然后调用 IMoniker::GetDisplayName 以获取该名字对象的显示名称。 此操作的成本可能很高,因为它可能需要绑定名字对象。 系统提供的所有名字对象都可以在不绑定的情况下返回显示名称,但不能保证其他名字对象实现可以返回。 容器应用程序可以缓存名称并在链接源绑定时更新名称,而不是重复调用 IOleLink::GetSourceDisplayName

要求

要求
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 oleidl.h

另请参阅

IMoniker::GetDisplayName

IOleLink

IOleLink::SetSourceDisplayName

IOleUILinkContainer

OleUIEditLinks