Skip to content

Latest commit

 

History

History
169 lines (124 loc) · 7.1 KB

nf-oledlg-ioleuilinkcontainera-getlinksource.md

File metadata and controls

169 lines (124 loc) · 7.1 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:oledlg.IOleUILinkContainerA.GetLinkSource
IOleUILinkContainerA::GetLinkSource (oledlg.h)
Retrieves information about a link that can be displayed in the Links dialog box. (ANSI)
GetLinkSource
GetLinkSource method [COM]
GetLinkSource method [COM]
IOleUILinkContainer interface
GetLinkSource method [COM]
IOleUILinkContainerA interface
GetLinkSource method [COM]
IOleUILinkContainerW interface
IOleUILinkContainer interface [COM]
GetLinkSource method
IOleUILinkContainer::GetLinkSource
IOleUILinkContainerA interface [COM]
GetLinkSource method
IOleUILinkContainerA.GetLinkSource
IOleUILinkContainerA::GetLinkSource
IOleUILinkContainerW interface [COM]
GetLinkSource method
IOleUILinkContainerW::GetLinkSource
_ole_IOleUILinkContainer_GetLinkSource
com.ioleuilinkcontainer_getlinksource
oledlg/IOleUILinkContainer::GetLinkSource
oledlg/IOleUILinkContainerA::GetLinkSource
oledlg/IOleUILinkContainerW::GetLinkSource
com\ioleuilinkcontainer_getlinksource.htm
com
10f1bc84-cc09-4a41-8f55-21314338f636
12/05/2018
GetLinkSource, GetLinkSource method [COM], GetLinkSource method [COM],IOleUILinkContainer interface, GetLinkSource method [COM],IOleUILinkContainerA interface, GetLinkSource method [COM],IOleUILinkContainerW interface, IOleUILinkContainer interface [COM],GetLinkSource method, IOleUILinkContainer::GetLinkSource, IOleUILinkContainerA interface [COM],GetLinkSource method, IOleUILinkContainerA.GetLinkSource, IOleUILinkContainerA::GetLinkSource, IOleUILinkContainerW interface [COM],GetLinkSource method, IOleUILinkContainerW::GetLinkSource, _ole_IOleUILinkContainer_GetLinkSource, com.ioleuilinkcontainer_getlinksource, oledlg/IOleUILinkContainer::GetLinkSource, oledlg/IOleUILinkContainerA::GetLinkSource, oledlg/IOleUILinkContainerW::GetLinkSource
oledlg.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Windows
19H1
IOleUILinkContainerA::GetLinkSource
oledlg/IOleUILinkContainerA::GetLinkSource
c++
APIRef
kbSyntax
COM
OleDlg.h
IOleUILinkContainer.GetLinkSource
IOleUILinkContainerA.GetLinkSource
IOleUILinkContainerW.GetLinkSource

IOleUILinkContainerA::GetLinkSource

-description

Retrieves information about a link that can be displayed in the Links dialog box.

-parameters

-param dwLink [in]

Container-defined unique identifier for a single link. See IOleUILinkContainer::GetNextLink.

-param lplpszDisplayName [out, optional]

Address of a pointer variable that receives a pointer to the full display name string for the link source. The Links dialog box will free this string.

-param lplenFileName [out]

Pointer to the length of the leading file name portion of the lplpszDisplayName string. If the link source is not stored in a file, then lplenFileName should be 0. For OLE links, call IOleLink::GetSourceDisplayName.

-param lplpszFullLinkType [out, optional]

Address of a pointer variable that receives a pointer to the full link type string that is displayed at the bottom of the Links dialog box. The caller allocates this string. The Links dialog box will free this string. For OLE links, this should be the full User Type name. Use IOleObject::GetUserType, specifying USERCLASSTYPE_FULL for dwFormOfType.

-param lplpszShortLinkType [out, optional]

Address of a pointer variable that receives a pointer to the short link type string that is displayed in the listbox of the Links dialog box. The caller allocates this string. The Links dialog box will free this string. For OLE links, this should be the short user type name. Use IOleObject::GetUserType, specifying USERCLASSTYPE_SHORT for dwFormOfType.

-param lpfSourceAvailable [out]

Pointer that returns FALSE if it is known that a link is unavailable since the link is to some known but unavailable document. Certain options, such as Update Now, are disabled (grayed in the user interface) for such cases.

-param lpfIsSelected [out]

Pointer to a variable that tells the Edit Links dialog box that this link's entry should be selected in the dialog's multi-selection listbox. OleUIEditLinks calls this method at least once for each item to be placed in the links list. If none of them return TRUE, then none of them will be selected when the dialog box is first displayed. If all of them return TRUE, then all will be displayed. That is, it returns TRUE if this link is currently part of the selection in the underlying document, FALSE if not. Any links that are selected in the underlying document are selected in the dialog box; this way, the user can select a set of links and use the dialog box to update them or change their source(s) simultaneously.

-returns

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

Return code Description
E_ACCESSDENIED
Insufficient access permissions.
E_FAIL
The operation failed.
E_INVALIDARG
The specified identifier is invalid.
E_OUTOFMEMORY
There is insufficient memory available for this operation.

-remarks

Notes to Callers

Call this method during dialog box initialization, after returning from the Change Source dialog box.

-see-also

IOleLink::GetSourceDisplayName

IOleObject::GetUserType

IOleUILinkContainer

OLEUICHANGESOURCE

OleUIChangeSource

USERCLASSTYPE