getTypeDocumentation      package:SWinTypeLibs      R Documentation

_D_o_c_u_m_e_n_t_a_t_i_o_n _f_o_r _T_y_p_e _E_l_e_m_e_n_t

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

     This retrieves the documentation for the specified entry in  the
     type library ('ITypeLib') or  'ITypeInfo' object.

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

     getTypeDocumentation(lib, which)

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

     lib: the 'ITypeLib' or 'ITypeInfo' object in which to find the
          documentation element. 

   which: the index of the entry (1-based) in the type library whose
          documentation is to be retrieved. If 'lib' is an instance of
          '\class{ITypeInfo-class}', a value of 0 gives the
          human-readable name of the  type.  Values 1, 2, ... give the
          names of the methods/property accessors. 

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

     A character vector of length 3 giving the  

DocString: the documentation string for this element.

Help Context: documentation for the context of this element.

Help File: the name of the help file.

_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:

     'LoadTypeLib' 'getTypeInfo' 'getTypeLibTypes'

_E_x_a_m_p_l_e_s:

     if(file.exists("c:\\WINNT\\system32\\wmpui.dll")) {
       l = LoadTypeLib("c:\\WINNT\\system32\\wmpui.dll")

       getTypeDocumentation(l, 0)

       getTypeDocumentation(l, 14)

       m <- matrix("", length(l), 3)
       for(i in 1:length(l)) {
        m[i, ] <- getTypeDocumentation(l, i)
       }
       print(m)

       w = COMCreate("Word.Application", existing = TRUE)
       lib = LoadTypeLib(w)
       getTypeDocumentation(lib[["Documents"]], 0)
       getTypeDocumentation(lib[["Documents"]], 1)
       lib = NULL
     }

