Comment faire pour créer un serveur RealTimeData pour Excel

Résumé

Microsoft Excel propose une nouvelle fonction de feuille de calcul, RTD, qui vous permet d’appeler un serveur du modèle d’objet composant (COM) Automation afin de récupérer des données en temps réel. Cet article décrit comment utiliser Visual Basic pour créer un serveur RealTimeData à utiliser avec la fonction RTD de Microsoft Excel.

Plus d'informations

La fonction de feuille de calcul RTD présente la syntaxe suivante :
= RTD (ProgID, serveur, chaîne1,[chaîne2],... )
Le premier argument, ProgID, représente l’identificateur programmatique (ProgID) du serveur RealTimeData. L’argument de serveur indique le nom de l’ordinateur sur lequel le serveur RealTimeData est exécuté ; Cet argument peut être une chaîne nulle ou omise 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 « nom de rubrique ». Les paramètres respectent la casse. Par exemple, l’exemple suivant illustre les appels vers le serveur RTD qui aboutissent à trois noms de rubriques séparés :
= RTD("ExcelRTD.RTDFunctions",,"AAA", "10")

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

= RTD("ExcelRTD.RTDFunctions",,"aaa", "5")
Dans l’ordre pour un serveur Automation COM soit un serveur RealTimeData à utiliser avec la fonction RTD de Microsoft Excel, il doit implémenter l’interface IRTDServer . Le serveur doit implémenter toutes les méthodes de IRTDServer:

ServerStart
Appelé lorsque Microsoft Excel demande la première rubrique RTD pour le serveur. ServerStart doit retourner la valeur 1 sur la 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 Microsoft Excel lorsqu’il doit rassembler les mises à jour à partir du serveur RealTimeData.
ServerTerminate
Appelé lorsque Microsoft Excel demande n’a plus de rubriques RTD à partir du serveur RealTimeData.
ConnectData
Appelé lorsque Microsoft Excel demande une nouvelle rubrique RTD à partir du serveur RealTimeData.
DisconnectData
Appelée chaque fois qu’Excel ne demande plus une rubrique spécifique.
Pulsation
Appelé par Microsoft Excel si un intervalle donné s’est écoulé depuis la dernière fois qu’Excel a été averti des mises à jour à partir du serveur RealTimeData.
RefreshData
Appelé lorsque Microsoft Excel demande une actualisation des rubriques. RefreshData est appelée une fois que le serveur a informé Microsoft Excel que les mises à jour, et retourne un compte des rubriques à mettre à jour ainsi que l’id de la rubrique et la valeur pour chaque rubrique.

Créer un serveur RealTimeData exemple

L’exemple suivant montre comment créer et utiliser un serveur RealTimeData avec Microsoft Excel 2002. Ce serveur fournit simplement un compte mis à jour toutes les 10 secondes sur 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é comme non valide et le serveur renvoie #VALUE ! pour la fonction RTD. La deuxième chaîne est une valeur numérique qui représente la manière dont la valeur de retour doit être incrémentée. Si la deuxième chaîne est omise, la valeur d’incrément par défaut est 1. Si la deuxième chaîne n’est pas numérique, le serveur renvoie # #NUM ! pour la fonction RTD.
  1. Démarrez un nouveau projet ActiveX DLL dans Visual Basic.
  2. Dans le menu projet , cliquez sur références, sélectionnez la bibliothèque d’objets correspondant à votre version de Microsoft Excel, puis cliquez sur OK. Par exemple, sélectionnez une des opérations 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 Projet1. Remplacez le Nom du projet ExcelRTD, puis cliquez sur OK.
  4. Modifiez la propriété nom du module de classe Classe1 en FonctionsRTD. Ajoutez le code suivant à FonctionsRTD:
    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 le nom de propriété du module de classe à la rubrique et la propriété Instancing Private. Ajoutez le code suivant au module de classe de rubrique :
    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.DL pour construire le composant.

Utilisez le serveur RTD dans Excel

  1. Démarrez un nouveau classeur dans Microsoft Excel.
  2. Dans la cellule A1, entrez la formule suivante et appuyez sur la touche ENTRÉE :
    = RTD("ExcelRTD.RTDFunctions",,"AAA", 5)
    La valeur renvoyée initiale est « AAA : 0 ». Après cinq secondes, la valeur de mises à jour « AAA : 10 » et après 10 secondes, la valeur de mises à jour « 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 renvoyée initiale est « BBB : 0 ». Toutes les cinq secondes la valeur de la cellule augmente de 3.

  4. Dans la cellule A3, entrez la formule suivante et appuyez sur ENTRÉE :
    = RTD("ExcelRTD.RTDFunctions",,"AAA", 5)
    La valeur renvoyée initiale correspond le contenu de la cellule A1 car il s’agit de la même « rubrique » 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 renvoyée initiale est « AAA : 0. » toutes les cinq secondes les incréments de valeur de cellule, comme le font les autres cellules. Notez que la valeur de retour ne correspond pas à la valeur de la cellule A1 ou A3 car la combinaison des paramètres transmis au serveur est différente.
Pour cet exemple, le serveur RTD a été compilé et Excel a utilisé la version d’exécution du composant. Aux fins de débogage, les serveurs RTD peuvent être exécutés à partir de l’IDE de Visual Basic.

Pour exécuter en mode débogage :
  1. Quittez Microsoft Excel et passez au projet dans 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 d’attendre la création de composants.
  3. Assurez-vous que la fenêtre exécution dans Visual Basic s’affiche. Lorsque vous entrez des formules dans les cellules et 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

Lorsque Excel est un abonné à votre serveur RTD, il déclenche l’événement DisconnectData lorsqu’il n’a plus besoin 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 Excel se ferme ; au lieu de cela, Excel appelle seulement ServerTerminate. Lorsque vous créez un serveur RTD, vous devez coder pour tout le nettoyage nécessaire des rubriques ou d’autres objets au déclenchement de l’événement ServerTerminate .

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

Références

Pour plus d’informations, cliquez sur le numéro ci-dessous pour afficher l’article correspondant dans la Base de connaissances Microsoft :

284883 le serveur RTD n’envoie pas les Notifications de mise à jour à plusieurs Instances Excel

Propriétés

ID d'article : 285339 - Dernière mise à jour : 26 janv. 2017 - Révision : 2

Commentaires