LibreOffice
LibreOffice 24.2 SDK API Reference
XRegistryKey.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 
21 
22 module com { module sun { module star { module registry {
23 
32 {
41  [readonly, attribute] string KeyName;
42 
48  boolean isReadOnly()
49  raises( com::sun::star::registry::InvalidRegistryException );
50 
53  boolean isValid();
54 
65  com::sun::star::registry::RegistryKeyType getKeyType( [in] string rKeyName )
66  raises( com::sun::star::registry::InvalidRegistryException );
67 
74  com::sun::star::registry::RegistryValueType getValueType()
75  raises( com::sun::star::registry::InvalidRegistryException );
76 
86  long getLongValue()
87  raises( com::sun::star::registry::InvalidRegistryException,
88  com::sun::star::registry::InvalidValueException );
89 
98  void setLongValue( [in] long value )
99  raises( com::sun::star::registry::InvalidRegistryException );
100 
101  // DOCUMENTATION CHANGED FOR XRegistryKey::getLongListValue
111  sequence<long> getLongListValue()
112  raises( com::sun::star::registry::InvalidRegistryException,
113  com::sun::star::registry::InvalidValueException );
114 
123  void setLongListValue( [in] sequence<long> seqValue )
124  raises( com::sun::star::registry::InvalidRegistryException );
125 
126  // DOCUMENTATION CHANGED FOR XRegistryKey::getAsciiValue
136  string getAsciiValue()
137  raises( com::sun::star::registry::InvalidRegistryException,
138  com::sun::star::registry::InvalidValueException );
139 
149  void setAsciiValue( [in] string value )
150  raises( com::sun::star::registry::InvalidRegistryException );
151 
152  // DOCUMENTATION CHANGED FOR XRegistryKey::getAsciiListValue
162  sequence<string> getAsciiListValue()
163  raises( com::sun::star::registry::InvalidRegistryException,
164  com::sun::star::registry::InvalidValueException );
165 
175  void setAsciiListValue( [in] sequence<string> seqValue )
176  raises( com::sun::star::registry::InvalidRegistryException );
177 
178  // DOCUMENTATION CHANGED FOR XRegistryKey::getStringValue
188  string getStringValue()
189  raises( com::sun::star::registry::InvalidRegistryException,
190  com::sun::star::registry::InvalidValueException );
191 
200  void setStringValue( [in] string value )
201  raises( com::sun::star::registry::InvalidRegistryException );
202 
203  // DOCUMENTATION CHANGED FOR XRegistryKey::getStringListValue
213  sequence<string> getStringListValue()
214  raises( com::sun::star::registry::InvalidRegistryException,
215  com::sun::star::registry::InvalidValueException );
216 
224  void setStringListValue( [in] sequence<string> seqValue )
225  raises( com::sun::star::registry::InvalidRegistryException );
226 
227  // DOCUMENTATION CHANGED FOR XRegistryKey::getBinaryValue
237  sequence<byte> getBinaryValue()
238  raises( com::sun::star::registry::InvalidRegistryException,
239  com::sun::star::registry::InvalidValueException );
240 
249  void setBinaryValue( [in] sequence<byte> value )
250  raises( com::sun::star::registry::InvalidRegistryException );
251 
267  com::sun::star::registry::XRegistryKey openKey( [in] string aKeyName )
268  raises( com::sun::star::registry::InvalidRegistryException );
269 
285  com::sun::star::registry::XRegistryKey createKey( [in] string aKeyName )
286  raises( com::sun::star::registry::InvalidRegistryException );
287 
293  void closeKey()
294  raises( com::sun::star::registry::InvalidRegistryException );
295 
306  void deleteKey( [in] string rKeyName )
307  raises( com::sun::star::registry::InvalidRegistryException );
308 
309  // DOCUMENTATION CHANGED FOR XRegistryKey::openKeys
319  sequence<com::sun::star::registry::XRegistryKey> openKeys()
320  raises( com::sun::star::registry::InvalidRegistryException );
321 
322  // DOCUMENTATION CHANGED FOR XRegistryKey::getKeyNames
330  sequence<string> getKeyNames()
331  raises( com::sun::star::registry::InvalidRegistryException );
332 
353  boolean createLink( [in] string aLinkName,
354  [in] string aLinkTarget )
355  raises( com::sun::star::registry::InvalidRegistryException );
356 
367  void deleteLink( [in] string rLinkName )
368  raises( com::sun::star::registry::InvalidRegistryException );
369 
370  // DOCUMENTATION CHANGED FOR XRegistryKey::getLinkTarget
381  string getLinkTarget( [in] string rLinkName )
382  raises( com::sun::star::registry::InvalidRegistryException );
383 
384  // DOCUMENTATION CHANGED FOR XRegistryKey::getResolvedName
396  string getResolvedName( [in] string aKeyName )
397  raises( com::sun::star::registry::InvalidRegistryException );
398 
399 };
400 
401 
402 }; }; }; };
403 
404 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Definition: Ambiguous.idl:20
makes structural information (except regarding tree structures) of a single registry key accessible...
Definition: XRegistryKey.idl:31
signals that the registry is invalid or an operation on the registry failed.
Definition: InvalidRegistryException.idl:27
string KeyName
This is the key of the entry relative to its parent.
Definition: XRegistryKey.idl:41
RegistryValueType
represents all possible types of a key value.
Definition: RegistryValueType.idl:30
signals that the value of the key is invalid or does not have the appropriate key type...
Definition: InvalidValueException.idl:27
base interface of all UNO interfaces
Definition: XInterface.idl:45
RegistryKeyType
represents all possible types of a key.
Definition: RegistryKeyType.idl:29