UDK 3.2.7 C/C++ API Reference
registry/registry.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /*************************************************************************
00003  *
00004  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
00005  *
00006  * Copyright 2000, 2010 Oracle and/or its affiliates.
00007  *
00008  * OpenOffice.org - a multi-platform office productivity suite
00009  *
00010  * This file is part of OpenOffice.org.
00011  *
00012  * OpenOffice.org is free software: you can redistribute it and/or modify
00013  * it under the terms of the GNU Lesser General Public License version 3
00014  * only, as published by the Free Software Foundation.
00015  *
00016  * OpenOffice.org is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Lesser General Public License version 3 for more details
00020  * (a copy is included in the LICENSE file that accompanied this code).
00021  *
00022  * You should have received a copy of the GNU Lesser General Public License
00023  * version 3 along with OpenOffice.org.  If not, see
00024  * <http://www.openoffice.org/license.html>
00025  * for a copy of the LGPLv3 License.
00026  *
00027  ************************************************************************/
00028 
00029 #ifndef _REGISTRY_REGISTRY_H_
00030 #define _REGISTRY_REGISTRY_H_
00031 
00032 #include <stddef.h>
00033 #include <rtl/ustring.h>
00034 #include <registry/regtype.h>
00035 #include <registry/regdllapi.h>
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif  /* __cplusplus */
00040 
00052 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_createKey(RegKeyHandle hKey,
00053                                          rtl_uString* keyName,
00054                                          RegKeyHandle* phNewKey);
00055 
00056 
00067 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openKey(RegKeyHandle hKey,
00068                                          rtl_uString* keyName,
00069                                          RegKeyHandle* phOpenKey);
00070 
00071 
00072 
00085 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openSubKeys(RegKeyHandle hKey,
00086                                              rtl_uString* keyName,
00087                                              RegKeyHandle** pphSubKeys,
00088                                              sal_uInt32* pnSubKeys);
00089 
00090 
00098 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeSubKeys(RegKeyHandle* phSubKeys,
00099                                                sal_uInt32 nSubKeys);
00100 
00101 
00110 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_deleteKey(RegKeyHandle hKey,
00111                                          rtl_uString* keyName);
00112 
00113 
00120 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeKey(RegKeyHandle hKey);
00121 
00122 
00128 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getKeyName(RegKeyHandle hKey, rtl_uString** pKeyName);
00129 
00130 
00143 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setValue(RegKeyHandle hKey,
00144                                            rtl_uString* keyName,
00145                                            RegValueType valueType,
00146                                            RegValue pData,
00147                                            sal_uInt32 valueSize);
00148 
00149 
00159 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setLongListValue(RegKeyHandle hKey,
00160                                                       rtl_uString* keyName,
00161                                                       sal_Int32* pValueList,
00162                                                       sal_uInt32 len);
00163 
00164 
00174 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setStringListValue(RegKeyHandle hKey,
00175                                                           rtl_uString* keyName,
00176                                                           sal_Char** pValueList,
00177                                                           sal_uInt32 len);
00178 
00179 
00189 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setUnicodeListValue(RegKeyHandle hKey,
00190                                                             rtl_uString* keyName,
00191                                                             sal_Unicode** pValueList,
00192                                                             sal_uInt32 len);
00193 
00194 
00206 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getValueInfo(RegKeyHandle hKey,
00207                                                rtl_uString* keyName,
00208                                                RegValueType* pValueType,
00209                                                sal_uInt32* pValueSize);
00210 
00211 
00222 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getValue(RegKeyHandle hKey,
00223                                            rtl_uString* keyName,
00224                                            RegValue pData);
00225 
00226 
00236 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getLongListValue(RegKeyHandle hKey,
00237                                                       rtl_uString* keyName,
00238                                                       sal_Int32** pValueList,
00239                                                       sal_uInt32* pLen);
00240 
00241 
00251 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getStringListValue(RegKeyHandle hKey,
00252                                                        rtl_uString* keyName,
00253                                                        sal_Char*** pValueList,
00254                                                        sal_uInt32* pLen);
00255 
00256 
00266 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getUnicodeListValue(RegKeyHandle hKey,
00267                                                          rtl_uString* keyName,
00268                                                          sal_Unicode*** pValueList,
00269                                                          sal_uInt32* pLen);
00270 
00271 
00279 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_freeValueList(RegValueType valueType,
00280                                                   RegValue pValueList,
00281                                                   sal_uInt32 len);
00282 
00293 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getKeyType(RegKeyHandle hKey,
00294                                           rtl_uString* keyName,
00295                                              RegKeyType* pKeyType);
00296 
00307 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getResolvedKeyName(RegKeyHandle hKey,
00308                                                     rtl_uString* keyName,
00309                                                    sal_Bool firstLinkOnly,
00310                                                       rtl_uString** pResolvedName);
00311 
00324 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_loadKey(RegKeyHandle hKey,
00325                                          rtl_uString* keyName,
00326                                          rtl_uString* regFileName);
00327 
00328 
00341 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_saveKey(RegKeyHandle hKey,
00342                                          rtl_uString* keyName,
00343                                          rtl_uString* regFileName);
00344 
00345 
00361 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_mergeKey(RegKeyHandle hKey,
00362                                            rtl_uString* keyName,
00363                                            rtl_uString* regFileName,
00364                                            sal_Bool bWarnings,
00365                                            sal_Bool bReport);
00366 
00367 
00374 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_createRegistry(rtl_uString* registryName,
00375                                                RegHandle* phRegistry);
00376 
00377 
00384 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRootKey(RegHandle hRegistry,
00385                                              RegKeyHandle* phRootKey);
00386 
00387 
00394 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getName(RegHandle hRegistry, rtl_uString** pName);
00395 
00396 
00402 REG_DLLPUBLIC sal_Bool REGISTRY_CALLTYPE reg_isReadOnly(RegHandle hReg);
00403 
00404 
00412 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_openRegistry(rtl_uString* registryName,
00413                                                RegHandle* phRegistry,
00414                                                RegAccessMode accessMode);
00415 
00416 
00422 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_closeRegistry(RegHandle hRegistry);
00423 
00424 
00432 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_destroyRegistry(RegHandle hRegistry,
00433                                                rtl_uString* registryName);
00434 
00435 
00443 REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_dumpRegistry(RegKeyHandle hKey);
00444 
00445 #ifdef __cplusplus
00446 }
00447 #endif
00448 
00449 #endif
00450 
00451 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines