Come creare un server RealTimeData per Excel

  • Articolo
  • Si applica a:
    Microsoft Excel

Riepilogo

Microsoft Excel offre una nuova funzione del foglio di lavoro, RTD, che consente di chiamare un server di automazione COM (Component Object Model) allo scopo di recuperare i dati in tempo reale. Questo articolo descrive come usare Visual Basic per creare un server RealTimeData da usare con la funzione RTD di Excel.

Ulteriori informazioni

La funzione del foglio di lavoro RTD ha la sintassi seguente:

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

Il primo argomento, ProgID, rappresenta l'identificatore programmatico (ProgID) del server RealTimeData. L'argomento Server indica il nome del computer in cui viene eseguito il server RealTimeData; questo argomento può essere una stringa Null o omesso se il server RealTimeData deve essere eseguito localmente. Gli argomenti rimanenti rappresentano semplicemente i parametri da inviare al server RealTimeData; ogni combinazione univoca di questi parametri rappresenta un "argomento", con un "ID argomento" associato. I parametri fanno distinzione tra maiuscole e minuscole. Ad esempio, il codice seguente illustra le chiamate al server RTD che comporterebbe tre ID argomento separati:

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

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

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

Affinché un server di automazione COM sia un server RealTimeData da usare con la funzione RTD di Excel, deve implementare l'interfaccia IRTDServer. Il server deve implementare tutti i metodi di IRTDServer:

  • ServerStart: chiamato quando Excel richiede il primo argomento RTD per il server. ServerStart deve restituire un valore 1 in caso di esito positivo e un valore negativo o 0 in caso di errore. Il primo parametro del metodo ServerStart è un oggetto callback utilizzato dal server RealTimeData per notificare a Excel quando deve raccogliere gli aggiornamenti dal server RealTimeData.

  • ServerTerminate: chiamato quando Excel non richiede più argomenti RTD dal server RealTimeData.

  • ConnectData: chiamato ogni volta che Excel richiede un nuovo argomento RTD dal server RealTimeData.

  • DisconnectData: chiamato ogni volta che Excel non richiede più un argomento specifico.

  • HeartBeat: chiamato da Excel se è trascorso un determinato intervallo dall'ultima notifica degli aggiornamenti dal server RealTimeData.

  • RefreshData: chiamato quando Excel richiede un aggiornamento sugli argomenti. RefreshData viene chiamato dopo che il server notifica a Excel che esistono aggiornamenti e restituisce un conteggio degli argomenti da aggiornare insieme all'ID e al valore dell'argomento per ogni argomento.

Creare un server RealTimeData di esempio

L'esempio seguente illustra come creare e usare un server RealTimeData con Microsoft Excel 2002. Questo server fornisce semplicemente un contatore aggiornato ogni 10 secondi in un foglio di lavoro. Il server accetta fino a due stringhe di argomento. La prima stringa di argomento può essere AAA, BBB e CCC; qualsiasi altra stringa di argomento è considerata non valida e il server restituisce #VALUE. alla funzione RTD. La seconda stringa è un valore numerico che rappresenta la modalità di incremento del valore restituito. Se la seconda stringa viene omessa, il valore di incremento predefinito è 1. Se la seconda stringa non è numerica, il server restituisce #NUM! alla funzione RTD.

  1. Avviare un nuovo progetto DLL ActiveX in Visual Basic.

  2. Nel menu Progetto fare clic su Riferimenti, selezionare la libreria di oggetti per la versione di Excel e quindi fare clic su OK. Ad esempio, selezionare una delle opzioni seguenti:

    • Per Microsoft Office Excel 2007 selezionare Libreria oggetti di Microsoft Excel 12.0.
    • Per Microsoft Office Excel 2003 selezionare Libreria oggetti di Microsoft Excel 11.0.
    • Per Microsoft Excel 2002 selezionare Libreria oggetti di Microsoft Excel 10.0.

  3. Scegliere Proprietà progetto1 dal menu Progetto. Modificare il nome del progetto in ExcelRTD e quindi fare clic su OK.

  4. Modificare la proprietà Name del modulo di classe Class1 in RTDFunctions. Aggiungere il codice seguente a 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. Scegliere Aggiungi modulo di classe dal menu Progetto. Modificare la proprietà Name del modulo di classe in Topic e impostare la proprietà Instancing su Private. Aggiungere il codice seguente al modulo della 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. Scegliere Aggiungi modulo dal menu Progetto. Aggiungere il codice seguente al nuovo modulo:

    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. Scegliere Crea ExcelRTD.dll dal menu File per compilare il componente.

Usare il server RTD in Excel

  1. Avviare una nuova cartella di lavoro in Microsoft Excel.

  2. Nella cella A1 immettere la formula seguente e quindi premere INVIO:

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

    Il valore restituito iniziale è "AAA: 0". Dopo cinque secondi, il valore viene aggiornato a "AAA: 10" e dopo 10 secondi, il valore viene aggiornato a "AAA:15" e così via.

  3. Nella cella A2 immettere la formula seguente e premere INVIO:

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

    Il valore restituito iniziale è "BBB: 0". Ogni cinque secondi il valore della cella aumenta di 3.

  4. Nella cella A3 immettere la formula seguente e premere INVIO:

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

    Il valore restituito iniziale corrisponde al contenuto della cella A1 perché si tratta dello stesso "argomento" usato in A1.

  5. Nella cella A4 immettere la formula seguente e premere INVIO: =RTD("ExcelRTD.RTDFunctions",,"AAA", 10)

    Il valore restituito iniziale è "AAA: 0." Ogni cinque secondi il valore della cella aumenta come le altre celle. Si noti che il valore restituito non corrisponde al contenuto della cella A1 o A3 perché la combinazione di parametri passati al server è diversa.

Per questa illustrazione, il server RTD è stato compilato ed Excel usava la versione in fase di esecuzione del componente. A scopo di debug, i server RTD possono essere eseguiti dall'IDE di Visual Basic.

Per eseguire in modalità di debug:

  1. Chiudere Microsoft Excel e passare al progetto in Visual Basic.
  2. Premere F5 per avviare il componente. Se viene visualizzata la finestra di dialogo Proprietà progetto, fare clic su OK per selezionare l'opzione predefinita Attendi la creazione dei componenti.
  3. Assicurarsi che venga visualizzata la finestra Immediata in Visual Basic. Quando si immettono formule nelle celle e quando le celle vengono aggiornate, esaminare il contenuto della finestra Immediata in Visual Basic per vedere quali azioni attivano i diversi eventi.

Nota

Per quanto riguarda l'evento DisconnectData

Mentre Excel è un sottoscrittore del server RTD, attiva l'evento DisconnectData quando non è più necessario un argomento, ad esempio quando si elimina o si cancella una formula RTD in una cella. Tuttavia, Excel non chiama DisconnectData in ogni argomento per il server RTD quando la cartella di lavoro viene chiusa o Excel viene chiuso; In Alternativa, Excel chiama solo ServerTerminate. Quando si crea un server RTD, è necessario codice per qualsiasi pulizia necessaria di argomenti o altri oggetti quando viene generato l'evento ServerTerminate.

(c) Microsoft Corporation 2001, Tutti i diritti riservati. Contributi di Lori B. Turner, Microsoft Corporation.