|
IOleLink::GetSourceMoniker
Retrieves the moniker identifying the link source of a linked object.
HRESULT GetSourceMoniker(
IMoniker **ppmk
| //Receives moniker identifying link source
| );
|
|
Parameter
ppmk
[out] Receives a pointer to an absolute moniker that identifies the link
source. May be NULL if an error occurs. If *ppmk is non-NULL, the implementation must call IUnknown::AddRef on the parameter; it is the caller's responsibility to call IUnknown::Release.
Return Values
S_OK
The moniker was returned successfully.
MK_E_UNAVAILABLE
No moniker is available.
Comments
Notes to Callers
Your container application can call IOleLink::GetSourceMoniker to display the current source of a link in the Links dialog box. Note that
this requires your container to use the IMoniker::GetDisplayName method to get the display name of the moniker. If you'd rather get the
display name directly, your container can call IOleLink::GetSourceDisplayName instead of IOleLink::GetSourceMoniker.
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::GetLinkSource to get the string it should display. Your implementation of that method can
call IOleLink::GetSourceMoniker.
Notes on Provided Implementation
The linked object stores both an absolute and a relative moniker for the link
source. If the relative moniker is non-NULL and a moniker is available for the
compound document, IOleLink::GetSourceMoniker returns the moniker created by composing the relative moniker onto the end of
the compound document's moniker. Otherwise, it returns the absolute moniker
or, if an error occurs, NULL.
The container specifies the absolute moniker when it calls one of the OleCreateLink functions to create a link. The application can call IOleLink::SetSourceMoniker or IOleLink::SetSourceDisplayName to change the absolute moniker. In addition, the linked object automatically
updates the monikers whenever it successfully binds to the link source, or when
it is bound to the link source and it receives a rename notification through
the IAdviseSink::OnRename method.
See Also
IOleLink::SetSourceDisplayName, IOleLink::SetSourceMoniker
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
|
