generateEventInterface: Create R interface to DCOM event class

generateEventInterfaceR Documentation

Create R interface to DCOM event class

Description

This function creates R code to provide an interface to a DCOM class or type that defines an event handler, i.e. a DCOM interface that is used to respond to events from an event source and so is a fixed server interface implemented by a client to handle these types of events. This function (generateEventInterface) creates the R code for a constructor function that can be used to create an instance of the event handler, along with knowledge of the methods, their identifiers, their parameter types and return types, etc. This is used when processing the event interface elements of a type library in generateInterface.

Usage

generateEventInterface(info, id, lib, defaultClassName = "CompiledCOMServer",
                        verbose = FALSE)

Arguments

info

the ITypeInfo-class object (typically of class ITypeInfoDispatch-class) that describes the event interface. It is from this that we get its methods.

id

a string (character vector of length 1) giving the human-readable name of the interface, e.g "WorkbookEvents"

lib

the ITypeLib-class object used to resolve references to other DCOM interfaces/types

defaultClassName

the name of the class to use as the base class when defining new R classes.

verbose

a logical value, with TRUE indicating that output reporting progress and the current activity should be displayed on the console.

Value

An object of class RCOMEventInterfaceDefinition-class.

Author(s)

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

References

http://msdn.microsoft.com/library http://www.omegahat.org/RWinTypeLibs

See Also

generateInterface generateClass


omegahat/SWinTypeLibs documentation built on Jan. 17, 2024, 6:40 p.m.