createCOMEventServerInfo {RDCOMEvents}R Documentation

Create default handlers for COM event interface

Description

This generates a collection of template (degenerate) functions that implement the specified interface. This is used to generate the definition of a full server object for a particular DCOM interface so that methods can be overridden with those given in methods. The resulting object can be used to instantiate the actual server object via createCOMEventServer.

Usage

createCOMEventServerInfo(info, eventIDInfo = info, 
                         methods = NULL, .lib = NULL, 
                         complete = is.null(methods), 
                         name = "", help = "", 
                         def = new("COMEventServerInfo"))

Arguments

info the ITypeInfo object in which to find the functions. This can be the name of the ITypeInfo element within the type library if .lib is specified.
eventIDInfo the ITypeInfo object in which to lookup the names and identifiers of the event types. This potentially can be different from info in that one might refer to the IDispatch interface and the other to the regular interface description. This can be the name of the ITypeInfo element within the type library if .lib is specified.
...
methods a named list of functions that are to be used as event handlers. These are used to replace the default or template functions created by reading the type information.
.lib if info or eventIDInfo are given as strings, this should be the ITypeLibrary object in which to find these elements.
complete a logical value. If TRUE, then we create a list of functions for all of the methods for the specified interface. Otherwise, we use only the methods given by .... One typically uses TRUE to find out about the different methods and their arguments so that one can provide implementations in the future. In other words, this is more of a development tool.
name a human-readable name for the COM class. This is the value assigned to the name slot in the def object.
help a string giving a short description of the server. This might be used in implementing s
def the object which is to be filled in by this function. This argument allows the caller to specify an instance of a derived (or compatible) class from COMEventServerInfo-class.

Value

A list containing two elements

methods the collection of named functions created by merging the caller-specified functions (via ...) into the template/default methods constructed from the event interface.
ids the mapping from the event identifiers to names given as an integer vector and computed via getEventNameIDs

Author(s)

Duncan Temple Lang <duncan@wald.ucdavis.edu>

References

http://www.omegahat.org/RDCOMServer http://www.omegahat.org/SWinRegistry

See Also

createCOMEventServer getEventNameIDs

Examples



[Package RDCOMEvents version 0.3-1 Index]