.resolveToplevelRegistryKey   package:SWinRegistry   R Documentation

_H_i_e_r_a_r_c_h_i_c_a_l _R_e_g_i_s_t_r_y _P_a_t_h _S_p_e_c_i_f_i_c_a_t_i_o_n

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

     This function is used in all of the registry functions in this
     package to identify a key within the registry. The basic
     philosophy is to allow easy ways to specify a position in the
     registry for both interactive and programmatic use. There are 2
     basic approaches which are then combined with two ways to specify
     the starting point. The two basic ways are to  a) specify the path
     via a single string whose path elements are separated by \\; or b)
     to specify the path elements as  separate elements of a character
     vector.

     One can specify the entire path in either of these ways, that is
     starting at the top-most node in the registry, e.g
     'HKEY_CURRENT_USER', 'HKEY_CLASSES_ROOT', ... Alternatively, one
     can specify the top-most node of interest via the 'top' argument
     and give the path from the node in either of these two ways.

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

     .resolveToplevelRegistryKey(top, path)

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

     top: the name of one of the top-level keys in the registry such as
           'HKEY_CURRENT_USER', 'HKEY_CLASSES_ROOT', etc. If one wants
          to specify this in the 'path' argument, pass this as 'NULL'
          or '""'

    path: the path of keys  in the registry given as a  single string
          with elements separated by '\\' or  a character vector with
          an per key in the path

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

     A list with the top-level key name and the sub-path from that
     given as a string with keys separated by '\\'. This is then used
     by the C code to identify the package.

_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://www.omegahat.org/SWinRegistry>

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

     'getRegistryValue' 'setRegistryValue'

     'createRegistryKey' 'deleteRegistryKey' 'flushRegistryKey'

     'getRegistryKeyValues' 'getRegistrySubKeyNames'

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

     #  .resolveToplevelRegistryKey("", "HKEY_CURRENT_USER\b\c")
       .resolveToplevelRegistryKey("HKEY_CURRENT_USER", "a\b\c")
       .resolveToplevelRegistryKey("HKEY_CURRENT_USER", c("a","b", "c"))

