IXllRtdFeedCallback::OnGetDataState

Called by the RTD server whenever Excel requests data for the specified topic.

virtual bool OnGetDataState(
   LPCWSTR lpszClient,
   LPCWSTR lpszTopic,
   LPVARIANT lpvntState
);

Parameters

lpszClient

A pointer to a null-terminated unicode string containing the name of the client. This will always be the same as the value passed in CXllRtdFeedServerProxy::RegisterClient().

lpszTopic

A pointer to a null-terminated unicode string containing the topic about which Excel requires information.

lpvntState

A pointer to an empty VARIANT which should be populated with the state value for the requested topic.

Remarks

This call may occur at any of three points:

1. For a new topic, that has just been requested from an add-in function, via a call to CXllRtdFeedServerProxy::CallRtd().
2. From a range in a previously saved workbook which has been reopened.
3. For a topic that has been updated by the client XLL using CXllRtdFeedServerProxy::UpdateTopic().

If data is available, the implementation method should set *lpvntState to a scalar state variable and return true. If no data is yet available, the implementation method should return false.

Requirements

Header: XllRtdFeedServerProxy.h

See Also

IXllRtdFeedCallback Class | IXllRtdFeedCallback Methods