IOleLink::GetUpdateOptions A4G1I

Retrieves a value indicating how often the linked object updates its cached data.

HRESULT GetUpdateOptions(

DWORD *pdwUpdateOpt	//Pointer to update option
);

Parameter

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 OLEUPDATEJTRC_N.

Return Value

S_OK

The update option was retrieved successfully.

Remarks

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_WWWDZ 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.