Cómo crear un servidor RealTimeData para Excel

  • Artículo
  • Se aplica a:
    Microsoft Excel

Resumen

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

Más información

La función de hoja de cálculo RTD tiene la siguiente sintaxis:

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

El primer argumento, ProgID, representa el identificador de programación (ProgID) del servidor RealTimeData. El argumento Server indica el nombre de la máquina en la que se ejecuta el servidor RealTimeData; este argumento puede ser una cadena nula o omitirse si el servidor RealTimeData se va a ejecutar localmente. Los argumentos restantes simplemente representan parámetros para enviar al servidor RealTimeData; cada combinación única de estos parámetros representa un "tema", que tiene un "id. de tema" asociado. Los parámetros distinguen mayúsculas de minúsculas. Por ejemplo, a continuación se muestran las llamadas al servidor RTD que darían como resultado tres identificadores de tema independientes:

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

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

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

Para que un servidor de automatización COM sea un servidor RealTimeData para su uso con la función RTD de Excel, debe implementar la interfaz IRTDServer. El servidor debe implementar todos los métodos de IRTDServer:

  • ServerStart: se llama cuando Excel solicita el primer tema RTD para el servidor. ServerStart debe devolver un valor 1 si se ha realizado correctamente y un valor negativo o 0 en caso de error. El primer parámetro del método ServerStart es un objeto de devolución de llamada que el servidor RealTimeData usa para notificar a Excel cuándo debe recopilar actualizaciones del servidor RealTimeData.

  • ServerTerminate: se llama cuando Excel ya no requiere temas RTD del servidor RealTimeData.

  • ConnectData: se llama cada vez que Excel solicita un nuevo tema RTD desde el servidor RealTimeData.

  • DisconnectData: se llama cada vez que Excel ya no requiere un tema específico.

  • HeartBeat: llamado por Excel si ha transcurrido un intervalo determinado desde la última vez que Excel recibió una notificación de actualizaciones del servidor RealTimeData.

  • RefreshData: se llama cuando Excel solicita una actualización en temas. Se llama a RefreshData después de que el servidor notifique a Excel que existen actualizaciones y devuelve un recuento de los temas que se van a actualizar junto con el identificador y el valor del tema para cada tema.

Creación de un servidor RealTimeData de ejemplo

En el ejemplo siguiente se muestra cómo crear y usar 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 #VALUE! a la función RTD. 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 de incremento es 1. Si la segunda cadena no es numérica, el servidor devuelve #NUM! a la función RTD.

  1. Inicie un nuevo proyecto DLL de ActiveX en Visual Basic.

  2. En el menú Proyecto , haga clic en Referencias, seleccione la biblioteca de objetos para la versión de Excel y, a continuación, haga clic en Aceptar. Por ejemplo, seleccione una de las siguientes opciones:

    • En 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.
    • En 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 a ExcelRTD y, a continuación, 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 compilar el componente.

Uso del servidor RTD en Excel

  1. Inicie un nuevo libro en Microsoft Excel.

  2. En la celda A1, escriba la fórmula siguiente y, a continuación, presione la tecla ENTRAR:

    =RTD("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:

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

    El valor devuelto inicial es "BBB: 0". Cada cinco segundos, el valor de la celda aumenta en 3.

  4. En la celda A3, escriba la fórmula siguiente y presione ENTRAR:

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

    El valor devuelto inicial coincide con el contenido de la celda A1 porque se trata del mismo "tema" que se usa en A1.

  5. En la celda A4, escriba la fórmula siguiente y presione Entrar: =RTD("ExcelRTD.RTDFunctions",,"AAA", 10)

    El valor devuelto inicial es "AAA: 0." Cada cinco segundos el valor de la celda aumenta al igual que 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.

En esta ilustración, se compiló el servidor RTD y Excel usaba la versión en tiempo de ejecución del componente. Con fines de depuración, los servidores RTD se pueden ejecutar desde el IDE de Visual Basic.

Para ejecutarse en modo de depuración:

  1. Salga de 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 Esperar a que se creen los componentes.
  3. Asegúrese de que se muestra la ventana Inmediato en Visual Basic. A medida que escribe fórmulas en las celdas y a medida que se actualizan las celdas, examine el contenido de la ventana Inmediato en Visual Basic para ver qué acciones desencadenan los diferentes eventos.

Nota:

Con respecto al evento DisconnectData

Aunque Excel es un suscriptor del servidor RTD, desencadena el evento DisconnectData cuando ya no necesita un tema (por ejemplo, al eliminar o borrar una fórmula RTD en una celda). Sin embargo, Excel no llama a DisconnectData en cada tema del servidor RTD cuando se cierra el libro o Excel cierra; En su lugar, Excel solo llama a ServerTerminate. Al crear un servidor RTD, debe codificar para cualquier limpieza necesaria de temas u otros objetos cuando se active el evento ServerTerminate.

(c) Microsoft Corporation 2001, Todos los derechos reservados. Contribuciones de Lori B. Turner, Microsoft Corporation.