IOleLink::GetUpdateOptions method
Retrieves a value indicating how often the linked object updates its cached data.
Syntax
HRESULT GetUpdateOptions( [out] DWORD *pdwUpdateOpt );
Parameters
- pdwUpdateOpt [out]
-
A pointer to a variable that receives 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 possible values for pdwUpdateOpt are taken from the enumeration OLEUPDATE.
Return value
This method returns S_OK on success.
Notes to Callers
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.
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
IDL |
|
|
IID |
IID_IOleLink is defined as 0000011d-0000-0000-C000-000000000046 |
See also