|
IOleLink::SetSourceDisplayName
Specifies the new link source of a linked object using a display name.
HRESULT SetSourceDisplayName(
LPCOLESTR pszStatusText
| //Display name of new link source
| );
|
|
Parameter
pszStatusText
[in] The display name of the new link source. It may not be NULL.
Return Values
S_OK
The display name was set successfully.
MkParseDisplayName errors
Setting the display name requires calling this function; therefore, this
method may return errors generated by this function.
Comments
Notes to Callers
Your container application can call IOleLink::SetSourceDisplayName when the end user changes the source of a link or breaks a link. Note that
this requires the linked object to create a moniker out of the display name. If
you'd rather parse the display name into a moniker yourself, your container can
call IOleLink::SetSourceMoniker instead of IOleLink::SetSourceDisplayName.
If you use the OleUIEditLinks API function to display the Links dialog box, you must implement the IOleUILinkContainer interface. The dialog box calls your implementations of IOleUILinkContainer::SetLinkSource and IOleUILinkContainer::CancelLink. Your implementation of these methods can call IOleLink::SetSourceDisplayName.
If your container application is immediately going to bind to a newly
specified link source, you should call MkParseDisplayName and IOleLink::SetSourceMoniker instead, and then call IOleLink::BindToSource using the bind context from the parsing operation. By reusing the bind
context, you can avoid redundant loading of objects that might otherwise occur.
Notes on Provided Implementation
The contract for IOleLink::SetSourceDisplayName does not specify when the linked object will parse the display name into a
moniker. The parsing can occur before IOleLink::SetSourceDisplayName returns, or the linked object can store the display name and parse it only
when it needs to bind to the link source. Note that parsing the display name is
potentially an expensive operation because it might require binding to the link
source. The provided implementation of IOleLink::SetSourceDisplayName parses the display name and then releases the bind context used in the parse
operation. This can result in running and then stopping the link source server.
If the linked object is bound to the current link source, the implementation
of IOleLink::SetSourceDisplayName breaks the connection.
For more information on how the linked object stores and uses the moniker to
the link source, see IOleLink::SetSourceMoniker.
See Also
IOleLink::SetSourceMoniker, IOleUILinkContainer, MkParseDisplayName, OleUIEditLinks
Related LinksSoftware for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
TMS Scripter Studio Pro components for Delphi/C++Builder
More Online Helps Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages
|
