IOleLink::GetUpdateOptions

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves a value indicating how often the linked object updates its cached data.

Syntax

HRESULT GetUpdateOptions(
  DWORD* pdwUpdateOpt 
);

Parameters

• pdwUpdateOpt
  [out] Pointer to a DWORD that specifies the current value for the linked object's update option, indicating how often the linked object updates the cached data for the linked object. The legal values for pdwUpdateOpt are taken from the enumeration OLEUPDATE.

Return Value

The method returns S_OK if the update option was retrieved successfully.

Remarks

Your container application should call IOleLink::GetUpdateOptions to display the current update option for a linked object.

A linked object's current update option is displayed in the Links dialog box.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Requirements