Share via

IOleLink::GetUpdateOptions

  • Article

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

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 Values

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. If you use the OleUIEditLinks function to display the Links dialog box, you must implement the IOleUILinkContainer interface. The dialog box calls your implementation of IOleUILinkContainer::GetLinkUpdateOptions to determine which update option it should display. Your implementation of that method should call IOleLink::GetUpdateOptions to retrieve the current update option.

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

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Oleidl.h, Oleidl.idl.
Link Library: Ole32.lib, Uuid.lib.

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.