Erstellen eines RealTimeData-Servers für Excel

  • Artikel
  • Gilt für::
    Microsoft Excel

Zusammenfassung

Microsoft Excel bietet eine neue Arbeitsblattfunktion, RTD, mit der Sie einen COM-Automatisierungsserver (Component Object Model) aufrufen können, um Daten in Echtzeit abzurufen. In diesem Artikel wird die Verwendung von Visual Basic zum Erstellen eines RealTimeData-Servers für die Verwendung mit der RTD-Funktion von Excel beschrieben.

Weitere Informationen

Die RTD-Arbeitsblattfunktion weist die folgende Syntax auf:

=RTD(ProgID,Server,String1,[String2],...)

Das erste Argument, ProgID, stellt die ProgID (Programmatic Identifier) des RealTimeData-Servers dar. Das Server-Argument gibt den Namen des Computers an, auf dem der RealTimeData-Server ausgeführt wird. Dieses Argument kann eine NULL-Zeichenfolge sein oder ausgelassen werden, wenn der RealTimeData-Server lokal ausgeführt werden soll. Die verbleibenden Argumente stellen lediglich Parameter dar, die an den RealTimeData-Server gesendet werden sollen. jede eindeutige Kombination dieser Parameter stellt ein "Thema" dar, dem eine "Themen-ID" zugeordnet ist. Bei Parametern wird die Groß-/Kleinschreibung beachtet. Im Folgenden werden z. B. Aufrufe an den RTD-Server veranschaulicht, die zu drei separaten Themen-IDs führen würden:

=RTD("ExcelRTD.RTDFunctions",,"AAA", "10")

=RTD("ExcelRTD.RTDFunctions",,"AAA", "5")

=RTD("ExcelRTD.RTDFunctions",,"aaa", "5")

Damit ein COM-Automatisierungsserver ein RealTimeData-Server für die Verwendung mit der RTD-Funktion von Excel ist, muss er die IRTDServer-Schnittstelle implementieren. Der Server muss alle Methoden von IRTDServer implementieren:

  • ServerStart: Wird aufgerufen, wenn Excel das erste RTD-Thema für den Server anfordert. ServerStart sollte eine 1 bei Erfolg und einen negativen Wert oder 0 bei Einem Fehler zurückgeben. Der erste Parameter der ServerStart-Methode ist ein Rückrufobjekt, das der RealTimeData-Server verwendet, um Excel zu benachrichtigen, wenn Updates vom RealTimeData-Server gesammelt werden sollen.

  • ServerTerminate: Wird aufgerufen, wenn Excel keine RTD-Themen mehr vom RealTimeData-Server benötigt.

  • ConnectData: Wird aufgerufen, wenn Excel ein neues RTD-Thema vom RealTimeData-Server anfordert.

  • DisconnectData: Wird aufgerufen, wenn Excel kein bestimmtes Thema mehr benötigt.

  • HeartBeat: Wird von Excel aufgerufen, wenn seit der letzten Benachrichtigung von Excel über Updates vom RealTimeData-Server ein bestimmtes Intervall vergangen ist.

  • RefreshData: Wird aufgerufen, wenn Excel eine Aktualisierung für Themen anfordert. RefreshData wird aufgerufen, nachdem der Server Excel benachrichtigt hat, dass Updates vorhanden sind, und es gibt eine Anzahl der zu aktualisierenden Themen zusammen mit der Themen-ID und dem Wert für jedes Thema zurück.

Erstellen eines RealTimeData-Beispielservers

Im folgenden Beispiel wird veranschaulicht, wie Sie einen RealTimeData-Server mit Microsoft Excel 2002 erstellen und verwenden. Dieser Server stellt einfach einen Zähler bereit, der alle 10 Sekunden auf einem Arbeitsblatt aktualisiert wird. Der Server akzeptiert bis zu zwei Themenzeichenfolgen. Die erste Themenzeichenfolge kann AAA, BBB und CCC sein. jede andere Themenzeichenfolge gilt als ungültig, und der Server gibt #VALUE! auf die RTD-Funktion. Die zweite Zeichenfolge ist ein numerischer Wert, der angibt, wie der Rückgabewert erhöht werden soll. Wenn die zweite Zeichenfolge nicht angegeben wird, wird der Inkrementwert standardmäßig auf 1 festgelegt. Wenn die zweite Zeichenfolge nicht numerisch ist, gibt der Server #NUM! auf die RTD-Funktion.

  1. Starten Sie ein neues ActiveX DLL-Projekt in Visual Basic.

  2. Klicken Sie im Menü "Projekt " auf "Verweise", wählen Sie die Objektbibliothek für Ihre Excel-Version aus, und klicken Sie dann auf "OK". Wählen Sie beispielsweise eine der folgenden Optionen aus:

    • Wählen Sie für Microsoft Office Excel 2007 die Microsoft Excel 12.0-Objektbibliothek aus.
    • Wählen Sie für Microsoft Office Excel 2003 die Microsoft Excel 11.0-Objektbibliothek aus.
    • Wählen Sie für Microsoft Excel 2002 die Microsoft Excel 10.0-Objektbibliothek aus.

  3. Klicken Sie im Menü "Projekt" auf "Project1-Eigenschaften". Ändern Sie den Projektnamen in ExcelRTD, und klicken Sie dann auf "OK".

  4. Ändern Sie die Name-Eigenschaft des Klassenmoduls Class1 in RTDFunctions. Fügen Sie den folgenden Code zu RTDFunctions hinzu:

    Option Explicit

Implements IRtdServer  'Interface allows Excel to contact this RealTimeData server

Private m_colTopics As Collection

Private Function IRtdServer_ConnectData(ByVal TopicID As Long, Strings() As Variant, GetNewValues As Boolean) As Variant
    '** ConnectData is called whenever a new RTD topic is requested

'Create a new topic class with the given TopicId and string and add it to the
    'm_colTopics collection
    Dim oTopic As New Topic
    m_colTopics.Add oTopic, CStr(TopicID)
    oTopic.TopicID = TopicID
    oTopic.TopicString = Strings(0)
    If UBound(Strings) >= 1 Then oTopic.SetIncrement Strings(1)

'For this example, the initial value for a new topic is always 0
    IRtdServer_ConnectData = oTopic.TopicValue

Debug.Print "ConnectData", TopicID
End Function

Private Sub IRtdServer_DisconnectData(ByVal TopicID As Long)
   '** DisconnectData is called whenever a specific topic is not longer needed

'Remove the topic from the collection
   m_colTopics.Remove CStr(TopicID)

Debug.Print "DisconnectData", TopicID
End Sub

Private Function IRtdServer_Heartbeat() As Long
    '** Called by Excel if the heartbeat interval has elapsed since the last time
    '   Excel was called with UpdateNotify.
    Debug.Print "HeartBeat"
End Function

Private Function IRtdServer_RefreshData(TopicCount As Long) As Variant()
    '** Called when Excel is requesting a refresh on topics. RefreshData will be called
    '   after an UpdateNotify has been issued by the server. This event should:
    '   - supply a value for TopicCount (number of topics to update)
    '   - return a two dimensional variant array containing the topic ids and the
    '     new values of each.

Dim oTopic As Topic, n As Integer
    ReDim aUpdates(0 To 1, 0 To m_colTopics.Count - 1) As Variant
    For Each oTopic In m_colTopics
        oTopic.Update
        aUpdates(0, n) = oTopic.TopicID
        aUpdates(1, n) = oTopic.TopicValue
        n = n + 1
    Next
    TopicCount = m_colTopics.Count
    IRtdServer_RefreshData = aUpdates

Debug.Print "RefreshData", TopicCount & " topics updated"
End Function

Private Function IRtdServer_ServerStart(ByVal CallbackObject As Excel.IRTDUpdateEvent) As Long
    '** ServerStart is called when the first RTD topic is requested

Set oCallBack = CallbackObject
    Set m_colTopics = New Collection
    g_TimerID = SetTimer(0, 0, TIMER_INTERVAL, AddressOf TimerCallback)
    If g_TimerID > 0 Then IRtdServer_ServerStart = 1       'Any value <1 indicates failure.

Debug.Print "ServerStart"
End Function

Private Sub IRtdServer_ServerTerminate()
    '** ServerTerminate is called when no more topics are needed by Excel.

KillTimer 0, g_TimerID

'** Cleanup any remaining topics. This is done here since 
    '   IRtdServer_DisconnectData is only called if a topic is disconnected 
    '   while the book is open. Items left in the collection when we terminate
    '   are those topics left running when the workbook was closed.

Dim oTopic As Topic
    For Each oTopic In m_colTopics
        m_colTopics.Remove CStr(oTopic.TopicID)
        Set oTopic = Nothing
    Next

Debug.Print "ServerTerminate"

End Sub

  5. Klicken Sie im Menü "Projekt" auf "Klassenmodul hinzufügen". Ändern Sie die Name-Eigenschaft des Klassenmoduls in "Thema" und die Eigenschaft "Instancing" in "Privat". Fügen Sie dem Topic-Klassenmodul den folgenden Code hinzu:

    Option Explicit

Private m_TopicID As Long
Private m_TopicString As String
Private m_Value As Variant
Private m_IncrementVal As Long

Private Sub Class_Initialize()
    m_Value = 0
    m_IncrementVal = 1
End Sub

Friend Property Let TopicID(ID As Long)
    m_TopicID = ID
End Property

Friend Property Get TopicID() As Long
    TopicID = m_TopicID
End Property

Friend Property Let TopicString(s As String)
    s = UCase(s)
    If s = "AAA" Or s = "BBB" Or s = "CCC" Then
        m_TopicString = s
    Else
        m_Value = CVErr(xlErrValue) 'Return #VALUE if not one of the listed topics
    End If
End Property

Friend Sub Update()
    On Error Resume Next 'the next operation will fail if m_Value is an error (like #NUM or #VALUE)
    m_Value = m_Value + m_IncrementVal
End Sub

Friend Sub SetIncrement(v As Variant)
    On Error Resume Next
    m_IncrementVal = CLng(v)
    If Err <> 0 Then
        m_Value = CVErr(xlErrNum) 'Return #NUM if Increment value is not numeric
    End If
End Sub

Friend Property Get TopicValue() As Variant
    If Not (IsError(m_Value)) Then
        TopicValue = m_TopicString & ": " & m_Value
    Else
        TopicValue = m_Value
    End If
End Property

  6. Wählen Sie im Menü "Projekt" die Option "Modul hinzufügen" aus. Fügen Sie dem neuen Modul den folgenden Code hinzu:

    Public Declare Function SetTimer Lib "user32" (ByVal hWnd As Long, _
ByVal nIDEvent As Long, ByVal uElapse As Long, ByVal lpTimerFunc As Long) As Long

Public Declare Function KillTimer Lib "user32" (ByVal hWnd As Long, ByVal nIDEvent As Long) As Long

Public Const TIMER_INTERVAL = 5000
Public oCallBack As Excel.IRTDUpdateEvent
Public g_TimerID As Long

Public Sub TimerCallback(ByVal hWnd As Long, ByVal uMsg As Long, ByVal idEvent As Long, ByVal dwTime As Long)
    oCallBack.UpdateNotify
End Sub

  7. Klicken Sie im Menü "Datei" auf "ExcelRTD.dll erstellen", um die Komponente zu erstellen.

Verwenden des RTD-Servers in Excel

  1. Starten Sie eine neue Arbeitsmappe in Microsoft Excel.

  2. Geben Sie in Zelle A1 die folgende Formel ein, und drücken Sie dann die EINGABETASTE:

    =RTD("ExcelRTD.RTDFunctions",;"AAA", 5)

    Der anfängliche Rückgabewert ist "AAA: 0". Nach fünf Sekunden wird der Wert auf "AAA: 10" und nach 10 Sekunden auf "AAA:15" und so weiter aktualisiert.

  3. Geben Sie in Zelle A2 die folgende Formel ein, und drücken Sie die EINGABETASTE:

    =RTD("ExcelRTD.RTDFunctions",;"BBB", 3)

    Der anfängliche Rückgabewert ist "BBB: 0". Alle fünf Sekunden wird der Zellwert um 3 erhöht.

  4. Geben Sie in Zelle A3 die folgende Formel ein, und drücken Sie die EINGABETASTE:

    =RTD("ExcelRTD.RTDFunctions",;"AAA", 5)

    Der anfängliche Rückgabewert stimmt mit dem Inhalt von Zelle A1 überein, da dies dasselbe "Thema" ist, das in A1 verwendet wird.

  5. Geben Sie in Zelle A4 die folgende Formel ein, und drücken Sie die EINGABETASTE: =RTD("ExcelRTD.RTDFunctions",,"AAA", 10)

    Der anfängliche Rückgabewert lautet "AAA: 0". Alle fünf Sekunden erhöht sich der Zellwert wie die anderen Zellen. Beachten Sie, dass der Rückgabewert nicht mit dem Inhalt von Zelle A1 oder A3 übereinstimmt, da die Kombination von Parametern, die an den Server übergeben werden, unterschiedlich ist.

Für diese Abbildung wurde der RTD-Server kompiliert, und Excel verwendet die Laufzeitversion der Komponente. Zum Debuggen können RTD-Server über die Visual Basic-IDE ausgeführt werden.

So führen Sie den Debugmodus aus:

  1. Beenden Sie Microsoft Excel, und wechseln Sie zu dem Projekt in Visual Basic.
  2. Drücken Sie F5, um die Komponente zu starten. Wenn das Dialogfeld "Projekteigenschaften" angezeigt wird, klicken Sie auf "OK", um die Standardoption "Auf Erstellung von Komponenten warten" auszuwählen.
  3. Stellen Sie sicher, dass das Direktfenster in Visual Basic angezeigt wird. Wenn Sie Formeln in die Zellen eingeben und die Zellen aktualisiert werden, überprüfen Sie den Inhalt des Direktfensters in Visual Basic, um zu sehen, welche Aktionen die verschiedenen Ereignisse auslösen.

Hinweis

Bezüglich des DisconnectData-Ereignisses

Während Excel ein Abonnent Ihres RTD-Servers ist, löst es das DisconnectData-Ereignis aus, wenn es kein Thema mehr benötigt (z. B. wenn Sie eine RTD-Formel in einer Zelle löschen oder löschen). Excel ruft disconnectData jedoch nicht für jedes Thema für den RTD-Server auf, wenn die Arbeitsmappe geschlossen oder Excel beendet wird. stattdessen ruft Excel nur "ServerTerminate" auf. Wenn Sie einen RTD-Server erstellen, sollten Sie code für alle erforderlichen Bereinigungen von Themen oder anderen Objekten schreiben, wenn das ServerTerminate-Ereignis ausgelöst wird.

(c) Microsoft Corporation 2001, Alle Rechte vorbehalten. Beiträge von Lori B. Turner, Microsoft Corporation.