Comment créer un serveur RealTimeData pour Excel

  • Article
  • S’applique à:
    Microsoft Excel

Résumé

Microsoft Excel fournit une nouvelle fonction de feuille de calcul, RTD, qui vous permet d’appeler un serveur COM (Component Object Model) Automation pour récupérer des données en temps réel. Cet article explique comment utiliser Visual Basic pour créer un serveur RealTimeData à utiliser avec la fonction RTD d’Excel.

Informations supplémentaires

La fonction de feuille de calcul RTD a la syntaxe suivante :

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

Le premier argument, ProgID, représente l’identificateur programmatique (ProgID) du serveur RealTimeData. L’argument Serveur indique le nom de l’ordinateur sur lequel le serveur RealTimeData est exécuté ; cet argument peut être une chaîne null ou omis si le serveur RealTimeData doit s’exécuter localement. Les arguments restants représentent simplement les paramètres à envoyer au serveur RealTimeData ; chaque combinaison unique de ces paramètres représente une « rubrique », qui a un « ID de rubrique » associé. Les paramètres respectent la casse. Par exemple, l’exemple suivant illustre les appels au serveur RTD qui entraîneraient trois ID de rubrique distincts :

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

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

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

Pour qu’un serveur COM Automation soit un serveur RealTimeData à utiliser avec la fonction RTD d’Excel, il doit implémenter l’interface IRTDServer. Le serveur doit implémenter toutes les méthodes d’IRTDServer :

  • ServerStart : Appelé quand Excel demande la première rubrique RTD pour le serveur. ServerStart doit retourner un 1 en cas de réussite et une valeur négative ou 0 en cas d’échec. Le premier paramètre de la méthode ServerStart est un objet de rappel que le serveur RealTimeData utilise pour avertir Excel quand il doit collecter les mises à jour du serveur RealTimeData.

  • ServerTerminate : appelé quand Excel n’a plus besoin de rubriques RTD à partir du serveur RealTimeData.

  • ConnectData : appelé chaque fois qu’Excel demande une nouvelle rubrique RTD au serveur RealTimeData.

  • DisconnectData : appelé chaque fois qu’Excel n’a plus besoin d’une rubrique spécifique.

  • HeartBeat : Appelé par Excel si un intervalle donné s’est écoulé depuis la dernière notification d’Excel des mises à jour du serveur RealTimeData.

  • RefreshData : appelé quand Excel demande une actualisation sur des rubriques. RefreshData est appelé après que le serveur a averti Excel qu’il existe des mises à jour et qu’il retourne le nombre de rubriques à mettre à jour, ainsi que l’ID et la valeur de chaque rubrique.

Créer un exemple de serveur RealTimeData

L’exemple suivant montre comment créer et utiliser un serveur RealTimeData avec Microsoft Excel 2002. Ce serveur fournit simplement un compteur mis à jour toutes les 10 secondes dans une feuille de calcul. Le serveur accepte jusqu’à deux chaînes de rubrique. La première chaîne de rubrique peut être AAA, BBB et CCC; toute autre chaîne de rubrique est considérée comme non valide et le serveur retourne #VALUE! à la fonction RTD. La deuxième chaîne est une valeur numérique qui représente la façon dont la valeur de retour doit être incrémentée. Si la deuxième chaîne est omise, la valeur par défaut d’incrément est 1. Si la deuxième chaîne n’est pas numérique, le serveur retourne #NUM! à la fonction RTD.

  1. Démarrez un nouveau projet de DLL ActiveX en Visual Basic.

  2. Dans le menu Projet , cliquez sur Références, sélectionnez la bibliothèque d’objets pour votre version d’Excel, puis cliquez sur OK. Par exemple, sélectionnez l’une des options suivantes :

    • Pour Microsoft Office Excel 2007, sélectionnez Bibliothèque d’objets Microsoft Excel 12.0.
    • Pour Microsoft Office Excel 2003, sélectionnez Bibliothèque d’objets Microsoft Excel 11.0.
    • Pour Microsoft Excel 2002, sélectionnez Bibliothèque d’objets Microsoft Excel 10.0.

  3. Dans le menu Projet, cliquez sur Propriétés de Project1. Remplacez le nom du projet par ExcelRTD, puis cliquez sur OK.

  4. Remplacez la propriété Name du module de classe Class1 par RTDFunctions. Ajoutez le code suivant à RTDFunctions :

    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. Dans le menu Projet, cliquez sur Ajouter un module de classe. Remplacez la propriété Nom du module de classe par Topic et remplacez la propriété Instancing par Private. Ajoutez le code suivant au module de classe Topic :

    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. Dans le menu Projet, sélectionnez Ajouter un module. Ajoutez le code suivant au nouveau module :

    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. Dans le menu Fichier, cliquez sur Créer ExcelRTD.dll pour générer le composant.

Utiliser le serveur RTD dans Excel

  1. Démarrez un nouveau classeur dans Microsoft Excel.

  2. Dans la cellule A1, entrez la formule suivante, puis appuyez sur la touche Entrée :

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

    La valeur de retour initiale est « AAA : 0 ». Après cinq secondes, la valeur est mise à jour sur « AAA : 10 » et après 10 secondes, la valeur est mise à jour sur « AAA:15 », et ainsi de suite.

  3. Dans la cellule A2, entrez la formule suivante et appuyez sur Entrée :

    =RTD(« ExcelRTD.RTDFunctions »,,"BBB », 3)

    La valeur de retour initiale est « BBB : 0 ». Toutes les cinq secondes, la valeur de la cellule s’incrémente de 3.

  4. Dans la cellule A3, entrez la formule suivante et appuyez sur Entrée :

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

    La valeur de retour initiale correspond au contenu de la cellule A1, car il s’agit de la même « rubrique » que celle utilisée dans A1.

  5. Dans la cellule A4, entrez la formule suivante et appuyez sur Entrée : =RTD(« ExcelRTD.RTDFunctions », « AAA », 10)

    La valeur de retour initiale est « AAA : 0 ». Toutes les cinq secondes, la valeur de la cellule s’incrémente comme les autres cellules. Notez que la valeur de retour ne correspond pas au contenu de la cellule A1 ou A3, car la combinaison des paramètres passés au serveur est différente.

Pour cette illustration, le serveur RTD a été compilé et Excel utilisait la version runtime du composant. À des fins de débogage, les serveurs RTD peuvent être exécutés à partir de l’IDE Visual Basic.

Pour s’exécuter en mode débogage :

  1. Quittez Microsoft Excel et basculez vers le projet en Visual Basic.
  2. Appuyez sur F5 pour démarrer le composant. Si la boîte de dialogue Propriétés du projet s’affiche, cliquez sur OK pour sélectionner l’option par défaut Attendre la création des composants.
  3. Vérifiez que la fenêtre Exécution dans Visual Basic est affichée. Lorsque vous entrez des formules dans les cellules et que les cellules sont mises à jour, examinez le contenu de la fenêtre Exécution dans Visual Basic pour voir quelles actions déclenchent les différents événements.

Remarque

Concernant l’événement DisconnectData

Bien qu’Excel soit abonné à votre serveur RTD, il déclenche l’événement DisconnectData lorsqu’il n’a plus besoin d’une rubrique (par exemple, lorsque vous supprimez ou effacez une formule RTD dans une cellule). Toutefois, Excel n’appelle pas DisconnectData sur chaque rubrique du serveur RTD lorsque le classeur est fermé ou qu’Excel quitte ; Au lieu de cela, Excel appelle uniquement ServerTerminate. Lorsque vous créez un serveur RTD, vous devez coder pour tout nettoyage nécessaire des rubriques ou d’autres objets lorsque l’événement ServerTerminate se déclenche.

(c) Microsoft Corporation 2001, Tous droits réservés. Contributions de Lori B. Turner, Microsoft Corporation.