Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

IOleLink::GetSourceDisplayName method

Retrieves the display name of the link source of the linked object.

Syntax


HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

Parameters

ppszDisplayName [out]

Address of a pointer variable that receives a pointer to the display name of the link source. If an error occurs, ppszDisplayName is set to NULL; otherwise, the implementation must use IMalloc::Alloc to allocate the string returned in ppszDisplayName, and the caller is responsible for calling IMalloc::Free to free it. Both caller and called use the allocator returned by CoGetMalloc.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return codeDescription
E_FAIL

The operation failed.

 

Retrieving the display name requires calling these functions; therefore, this method may return errors generated by CreateBindCtx and IMoniker::GetDisplayName.

Remarks

Notes to Callers

Your container application can call IOleLink::GetSourceDisplayName to display the current source of a link.

The current source of a link is displayed in the Links dialog box. If you use the OleUIEditLinks function to display the Links dialog box, you must implement the IOleUILinkContainer interface. The dialog box calls your implementations of IOleUILinkContainer::GetLinkSource to get the string it should display. Your implementation of that method can call IOleLink::GetSourceDisplayName.

Notes to Implementers

The linked object's implementation of IOleLink::GetSourceDisplayName calls IOleLink::GetSourceMoniker to get the link source moniker, and then calls IMoniker::GetDisplayName to get that moniker's display name. This operation is potentially expensive because it might require binding the moniker. All of the system-provided monikers can return a display name without binding, but there is no guarantee that other moniker implementations can. Instead of making repeated calls to IOleLink::GetSourceDisplayName, your container application can cache the name and update it whenever the link source is bound.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleIdl.h

IDL

OleIdl.Idl

IID

IID_IOleLink is defined as 0000011d-0000-0000-C000-000000000046

See also

IOleLink
IOleLink::SetSourceDisplayName
IOleUILinkContainer
IMoniker::GetDisplayName
OleUIEditLinks

 

 

Community Additions

ADD
Show:
© 2015 Microsoft