getConnectionPoints {RDCOMEvents}R Documentation

Retrieve Event Source objects in a COM object

Description

This gets the COM connection points or event source objects from a given COM object. Each of these is an event source for a different interface or collection of event handler methods. One can connect an appropriate COM object as an event handler to one of these sources using connectConnectionPoint.

Usage

getConnectionPoints(obj, ids = NULL, expand = TRUE)

Arguments

obj the COM object in which we find the connection point instances.
ids if specified, a character vector giving the stringified UUIDs of the connection points of interest. This allows one to only retrieve that particular value, although it is not implemented that way currently.
expand a logical value. If this is TRUE, the basic IConnectionPoint-class is turned into a IExpandedConnectionPoint-class and this provides information about the UUID of the interface needed to implement the methods for this connection point and also the parent object associated with the connection point. This information can then be used to simplify the connection to the event source as the object becomes self-describing.

Value

A list with as many S IConnectionPoint-class or IExpandedConnectionPoint-class objects as there are in the underlying COM object. The names of the elements in the list are the stringified UUIDs identifying the COM interface for the event handler.

Author(s)

Duncan Temple Lang (duncan@wald.ucdavis.edu)

References

http://www.omegahat.org/RDCOMClient http://www.omegahat.org/RDCOMServer http://www.omegahat.org/SWinTypeLibs

See Also

connectConnectionPoint disconnectConnectionPoint

Examples

 e = COMCreate("Excel.Application")
 src = getConnectionPoints(e)[[1]]

 e$Quit()
 rm(list=c("e", "src"))
 gc()

[Package RDCOMEvents version 0.3-1 Index]