1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef _COMPHELPER_REGPATHHELPER_HXX_
25*b1cdbd2cSJim Jagielski #define _COMPHELPER_REGPATHHELPER_HXX_
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski namespace comphelper
30*b1cdbd2cSJim Jagielski {
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski /**
33*b1cdbd2cSJim Jagielski  * This function returns a path to the user registry file.
34*b1cdbd2cSJim Jagielski  * Search for the user registry using the following rules:
35*b1cdbd2cSJim Jagielski  * <dl>
36*b1cdbd2cSJim Jagielski  * <dt> 1. (for further use) search in sversion.ini (.sversionrc) for an entry
37*b1cdbd2cSJim Jagielski  *		REGISTRY_VERSION_STRING (example: UserRegistry 5.0/505=test.rdb) in the section
38*b1cdbd2cSJim Jagielski  *		[Registry]. If found, then take this value instead of the name "user.rdb".
39*b1cdbd2cSJim Jagielski  * <dt> 2. Search in the config directory of the user for a file "user.rdb". If
40*b1cdbd2cSJim Jagielski  *		found return the full path and name of the file. If not found, retry this
41*b1cdbd2cSJim Jagielski  *		step with a dot before ".user.rdb".
42*b1cdbd2cSJim Jagielski  * <dt> 3. If not found a new user registry with name "user.rdb" will be created in the user
43*b1cdbd2cSJim Jagielski  *		config directory.
44*b1cdbd2cSJim Jagielski  * </dl>
45*b1cdbd2cSJim Jagielski  *<BR>
46*b1cdbd2cSJim Jagielski  * @author Juergen Schmidt
47*b1cdbd2cSJim Jagielski  */
48*b1cdbd2cSJim Jagielski ::rtl::OUString getPathToUserRegistry();
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski /**
51*b1cdbd2cSJim Jagielski  * This function returns a path to the system registry file.
52*b1cdbd2cSJim Jagielski  * The system registry will always be searched in the same directory of the
53*b1cdbd2cSJim Jagielski  * executable. The name of the system registry is "applicat.rdb". If the system
54*b1cdbd2cSJim Jagielski  * registry was not found, then the environment variable STAR_REGISTRY will be checked.
55*b1cdbd2cSJim Jagielski  * If this variable was set, it must contain a full path to a valid system registry.
56*b1cdbd2cSJim Jagielski  * Search for the user registry using the following rules:
57*b1cdbd2cSJim Jagielski  *
58*b1cdbd2cSJim Jagielski  *<BR>
59*b1cdbd2cSJim Jagielski  * @author Juergen Schmidt
60*b1cdbd2cSJim Jagielski  */
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski ::rtl::OUString getPathToSystemRegistry();
63*b1cdbd2cSJim Jagielski 
64*b1cdbd2cSJim Jagielski }
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski #endif
67*b1cdbd2cSJim Jagielski 
68