Cómo crear un servidor RealTimeData para Excel

Microsoft Excel proporciona una nueva función de hoja de cálculo, RDTR, que le permite llamar a un servidor de Automatización del Modelo de objetos componentes (COM) con el fin de recuperar el tiempo real de los datos. En este artículo se describe cómo utilizar Visual Basic para crear un servidor RealTimeData que se usará con la función RDTR de Excel.

La función de hoja de cálculo RDTR tiene la sintaxis siguiente: El primer argumento, ProgID, representa el Identificador de programación (ProgID) del servidor RealTimeData. El argumento Servidor indica el nombre del equipo en el que se ejecuta el servidor RealTimeData; este argumento puede ser una cadena nula o se puede omitir si el servidor RealTimeData va a ejecutarse localmente. Los argumentos restantes simplemente representan los parámetros que se van a enviar al servidor RealTimeData; cada combinación única de estos parámetros representa un "tema", que tiene un "identificador de tema" asociado. En los parámetros se distinguen mayúsculas y minúsculas. Por ejemplo, a continuación se muestran llamadas al servidor de RDTR que producirían tres Id. de tema diferentes: Para que un servidor de Automatización COM sea un servidor RealTimeData para usarlo con la función RDTR de Excel, debe implementar la interfaz IRTDServer. El servidor debe implementar todos los métodos de IRTDServer:

ServerStartServerTerminateConnectDataDisconnectDataHeartBeatRefreshData

Crear un servidor RealTimeData de ejemplo

En el ejemplo siguiente se muestra cómo crear y utilizar un servidor RealTimeData con Microsoft Excel 2002. Este servidor simplemente proporciona un contador que se actualiza cada 10 segundos en una hoja de cálculo. El servidor acepta hasta dos cadenas de tema. La primera cadena de tema puede ser AAA, BBB y CCC; cualquier otra cadena de tema se considera no válida y el servidor devuelve #¡VALOR! a la función RDTR. La segunda cadena es un valor numérico que representa cómo se debe incrementar el valor devuelto. Si se omite la segunda cadena, el valor predeterminado del incremento es 1. Si la segunda cadena no es numérica, el servidor devuelve ¡#NUM! a la función RDTR.

1. Inicie un nuevo proyecto DLL ActiveX en Visual Basic.
2. En el menú Proyecto, haga clic en Referencias, seleccione la Biblioteca de objetos correspondiente a su versión de Excel y haga clic en Aceptar. Por ejemplo, seleccione una de las opciones siguientes:
   • Para Microsoft Office Excel 2007, seleccione Biblioteca de objetos de Microsoft Excel 12.0.
   • Para Microsoft Office Excel 2003, seleccione Biblioteca de objetos de Microsoft Excel 11.0.
   • Para Microsoft Excel 2002, seleccione Biblioteca de objetos de Microsoft Excel 10.0.
3. En el menú Proyecto, haga clic en Propiedades de Project1. Cambie el Nombre del proyecto por ExcelRTD y haga clic en Aceptar.
4. Cambie la propiedad Name del módulo de clase Class1 a RTDFunctions. Agregue el código siguiente 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. En el menú Proyecto, haga clic en Agregar módulo de clase. Cambie la propiedad Name del módulo de clase a Topic y cambie la propiedad Instancing a Private. Agregue el código siguiente al módulo de clase 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. En el menú Proyecto, seleccione Agregar módulo. Agregue el código siguiente al nuevo módulo:

   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. En el menú Archivo, haga clic en Crear ExcelRTD.dll para generar el componente.

Utilizar el servidor RTD en Excel

1. Inicie un libro nuevo en Microsoft Excel.
2. En la celda A1, escriba la fórmula siguiente y presione la tecla Entrar:
   =RDTR("ExcelRTD.RTDFunctions",,"AAA", 5)
   El valor devuelto inicial es "AAA: 0". Después de cinco segundos, el valor se actualiza a "AAA: 10" y después de 10 segundos, el valor se actualiza a "AAA:15", y así sucesivamente.
   
   
3. En la celda A2, escriba la fórmula siguiente y presione Entrar:
   =RDTR("ExcelRTD.RTDFunctions",,"BBB", 3)
   El valor devuelto inicial es "BBB: 0". Cada cinco segundos el valor de celda se incrementa en 3.
   
   
4. En la celda A3, escriba la fórmula siguiente y presione Entrar:
   =RDTR("ExcelRTD.RTDFunctions",,"AAA", 5)
   El valor devuelto inicial coincide con el contenido de la celda A1 porque se trata del mismo "tema" que se utiliza en A1.
   
   
5. En la celda A4, escriba la fórmula siguiente y presione Entrar:
   =RDTR("ExcelRTD.RTDFunctions",,"AAA", 10)
   El valor devuelto inicial es "AAA: 0." Cada cinco segundos el valor de celda se incrementa como en las demás celdas. Tenga en cuenta que el valor devuelto no coincide con el contenido de la celda A1 o A3 porque la combinación de parámetros pasados al servidor es diferente.

Para este ejemplo, se compiló el servidor RTD y Excel utilizó la versión en tiempo de ejecución del componente. A efectos de depuración, los servidores RTD pueden ejecutarse desde el IDE de Visual Basic.

Para ejecutarlo en modo de depuración:

1. Cierre Microsoft Excel y cambie al proyecto en Visual Basic.
2. Presione F5 para iniciar el componente. Si aparece el cuadro de diálogo Propiedades del proyecto, haga clic en Aceptar para seleccionar la opción predeterminada de Esperar que se creen los componentes.
3. Asegúrese de que se muestra la ventana Inmediata en Visual Basic. A medida que escriba fórmulas en las celdas y éstas se actualicen, examine el contenido de la ventana Inmediata en Visual Basic para ver qué acciones están activando los distintos eventos.

Nota relativa al evento DisconnectData

Aunque Excel es un suscriptor de su servidor RTD, desencadena el evento DisconnectData cuando ya no necesita un tema (por ejemplo, cuando elimina o borra una fórmula de RDTR en una celda). Sin embargo, Excel no llama a DisconnectData en cada tema para el servidor RTD cuando se cierra el libro o se sale de Excel; en su lugar, Excel sólo llama a ServerTerminate. Cuando está creando un servidor RTD, debe incluir en el código cualquier limpieza necesaria de temas u otros objetos cuando se desencadene el evento ServerTerminate.

(c) Microsoft Corporation 2001, Reservados todos los derechos. Con la colaboración de Lori B. Turner, Microsoft Corporation.

Para obtener más información al respecto, haga clic en el número de artículo siguiente para verlo en Microsoft Knowledge Base: