Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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 DWORDthat 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 pdwUpdateOptare 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::GetUpdateOptionsto display the current update option for a linked object.

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

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

Requirements

Header Oleidl.h, oleidl.idl
Library ole32.lib, uuid.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later