IOleLink::GetSourceDisplayName

  • Article

This method retrieves the display name of the link source of the linked object.

HRESULT GetSourceDisplayName(
  LPOLESTR* ppszDisplayName  
);

Parameters

  • ppszDisplayName
    [out] Address of LPOLESTR pointer variable that receives a pointer to the zero-terminated wide character string (2 bytes per character) containing the display name of the link source. If an error occurs, *ppszDisplayName is set to NULL; otherwise, the implementation must use the IMalloc::Alloc method to allocate the string returned in *ppszDisplayName, and the caller is responsible for calling the IMalloc::Free method to free it. Both the caller and called use the allocator returned by the CoGetMalloc function.

Return Values

This method supports the standard return value E_FAIL. The following table shows the additional return values for this method.

Value Descriptio
S_OK The display name was successfully retrieved.
CreateBindCtx and IMoniker::GetDisplayName errors Retrieving the display name requires calling these functions; therefore, this method can return errors generated by these functions.

Remarks

The linked object's implementation of IOleLink::GetSourceDisplayName calls the IOleLink::GetSourceMoniker method 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-supplied 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.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

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.

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Oleidl.h, Oleidl.idl.
Link Library: Ole32.lib, Uuid.lib.

See Also

CreateBindCtx | CoGetMalloc | IMalloc::Alloc | IMalloc::Free | IMoniker::GetDisplayName | IOleLink::GetSourceMoniker | IOleLink::SetSourceDisplayName

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.