generateClass          package:SWinTypeLibs          R Documentation

_C_r_e_a_t_e _R _c_o_d_e _t_o _i_n_t_e_r_f_a_c_e _t_o _D_C_O_M _c_l_a_s_s/_t_y_p_e

_D_e_s_c_r_i_p_t_i_o_n:

     This function is part of the code generation  mechanism to
     interface to DCOM classes/types in a type library. This function
     generates the R code to access the methods and properties of the
     DCOM interface along with additional information about class
     definitions, etc.

_U_s_a_g_e:

     generateClass(id, lib, defaultClass = "CompiledCOMIDispatch", 
                   defaultListClass = c("COMList", "COMTypedList"),
                   verbose = FALSE)

_A_r_g_u_m_e_n_t_s:

      id: a string giving the human-readable name of the DCOM interface
          in the type library.

     lib: the type library of class 'ITypeLib-class' in which the
          interface information is to be found.

defaultClass: a string giving the name of the R class that is to be
          used as the base class for new classes defined  to represent
          DCOM classes. This is used if the DCOM class is not a list.
          See  'computeClassName' and 'getListClassName' in the file
          'generate.S'. 

defaultListClass: either a function or a character vector. If this is a
          function, this is called to determine the class definition of
          the new S class to be constructed to represent references to
          the DCOM objects of this type. The function must return an
          object derived from 'ClassDefinition-class'. This allows the
          caller to specify her own function to compute S class
          definitions from DCOM types.

          Alternatively, if this is given as a character vector, it
          should give the names of classes that are used for "untyped"
          and "typed" lists, in that order. By typed lists, we mean
          where we know the (base) type of the elements in the DCOM
          list.  If these are general VARIANT or IDispatch objects,
          then it is an untyped list. 

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

_V_a_l_u_e:

     An object of class 'RCOMDispatchInterfaceDefinition-class'

_A_u_t_h_o_r(_s):

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

_R_e_f_e_r_e_n_c_e_s:

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

_S_e_e _A_l_s_o:

     'generateInterface' 'generateEventInterface'

