IOleUILinkContainerA::SetLinkSource method (oledlg.h)

Article
07/27/2022

Changes the source of a link.

Syntax

HRESULT SetLinkSource(
  [in]  DWORD dwLink,
  [in]  LPSTR lpszDisplayName,
  [in]  ULONG lenFileName,
  [out] ULONG *pchEaten,
  [in]  BOOL  fValidateSource
);

Parameters

[in] dwLink

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

[in] lpszDisplayName

Pointer to new source string to be parsed.

[in] lenFileName

Length of the leading file name portion of the lpszDisplayName string. If the link source is not stored in a file, then lenFileName should be 0. For OLE links, call IOleLink::GetSourceDisplayName.

[out] pchEaten

Pointer to the number of characters successfully parsed in lpszDisplayName.

[in] fValidateSource

TRUE if the moniker should be validated; for OLE links, MkParseDisplayName should be called. FALSE if the moniker should not be validated. If possible, the link should accept the unvalidated source, and mark itself as unavailable.

Return value

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 supplied identifier is invalid.
E_OUTOFMEMORY	Insufficient memory available for this operation.

Remarks

Notes to Callers

Call this method from the Change Source dialog box, with fValidateSource initially set to TRUE. Change Source can be called directly or from the Links dialog box. If this call to IOleUILinkContainer::SetLinkSource returns an error (e.g., MkParseDisplayName failed because the source was unavailable), then you should display an Invalid Link Source message, and the user should be allowed to decide whether to fix the source. If the user chooses to fix the source, then the user should be returned to the Change Source dialog box with the invalid portion of the input string highlighted. If the user chooses not to fix the source, then IOleUILinkContainer::SetLinkSource should be called a second time with fValidateSource set to FALSE, and the user should be returned to the Links dialog box with the link marked Unavailable.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	oledlg.h