COMStop             package:RDCOMClient             R Documentation

_G_e_n_e_r_a_l _E_r_r_o_r _f_u_n_c_t_i_o_n _f_o_r _C_O_M _e_r_r_o_r_s

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

     This is a general function for raising an exception in a DCOM
     computation from within R. It takes a message and a status  code
     (an integer from the DCOM operation) and raises an error. The
     class of the error can be specified allowing for different types
     of errors to be distinguished. It is the ability to specify the
     class of the error that makes this general.

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

     COMStop(msg, status, class)

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

     msg: a message string to display in the error, intended to be
          human readable.

  status: an integer that identifies the type of the DCOM error. These
          are interpreted relative to a table of errors. We should make
          this available from the R language by accessing the C
          structures. 

   class: a character vector giving the name of the class(es) for the
          error being created. One can specify different class names to
          allow error handlers to easily differentiate between types of
          errors using 'tryCatch'.

_D_e_t_a_i_l_s:

     This uses the exception mechanism in R to provide extensible error
     objects that can be caught in a flexible manner.

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

     An error object of the class specified by '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:

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

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

     '.COM'

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

     ## Not run: 
        COMStop("A fake error message", 1, "FakeCOMError")
     ## End(Not run)

