IOleUILinkContainer::SetLinkUpdateOptions method

Sets a link's update options to automatic or manual.

Syntax


HRESULT SetLinkUpdateOptions(
  [in] DWORD dwLink,
  [in] DWORD dwUpdateOpt
);

Parameters

dwLink [in]

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

dwUpdateOpt [in]

Update options, which can be automatic (OLEUPDATE_ALWAYS) or manual (OLEUPDATE_ONCALL).

Return value

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

Return codeDescription
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 Implementers

Containers can implement this method for OLE links by simply calling IOleLink::SetUpdateOptions on the link object.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleDlg.h

IID

IID_IOleUILinkContainer is defined as 000004FF-0000-0000-C000-000000000046

See also

IOleUILinkContainer
IOleUILinkContainer::GetNextLink
IOleLink::SetUpdateOptions
IOleLink::SetUpdateOptions

 

 

Show: