LibreOffice
LibreOffice 7.3 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#ifndef __com_sun_star_registry_XRegistryKey_idl__
20#define __com_sun_star_registry_XRegistryKey_idl__
21
27
28
29
30module com { module sun { module star { module registry {
31
40{
49 [readonly, attribute] string KeyName;
50
56 boolean isReadOnly()
57 raises( com::sun::star::registry::InvalidRegistryException );
58
61 boolean isValid();
62
73 com::sun::star::registry::RegistryKeyType getKeyType( [in] string rKeyName )
74 raises( com::sun::star::registry::InvalidRegistryException );
75
82 com::sun::star::registry::RegistryValueType getValueType()
83 raises( com::sun::star::registry::InvalidRegistryException );
84
94 long getLongValue()
95 raises( com::sun::star::registry::InvalidRegistryException,
96 com::sun::star::registry::InvalidValueException );
97
106 void setLongValue( [in] long value )
107 raises( com::sun::star::registry::InvalidRegistryException );
108
109 // DOCUMENTATION CHANGED FOR XRegistryKey::getLongListValue
119 sequence<long> getLongListValue()
120 raises( com::sun::star::registry::InvalidRegistryException,
121 com::sun::star::registry::InvalidValueException );
122
131 void setLongListValue( [in] sequence<long> seqValue )
132 raises( com::sun::star::registry::InvalidRegistryException );
133
134 // DOCUMENTATION CHANGED FOR XRegistryKey::getAsciiValue
144 string getAsciiValue()
145 raises( com::sun::star::registry::InvalidRegistryException,
146 com::sun::star::registry::InvalidValueException );
147
157 void setAsciiValue( [in] string value )
158 raises( com::sun::star::registry::InvalidRegistryException );
159
160 // DOCUMENTATION CHANGED FOR XRegistryKey::getAsciiListValue
170 sequence<string> getAsciiListValue()
171 raises( com::sun::star::registry::InvalidRegistryException,
172 com::sun::star::registry::InvalidValueException );
173
183 void setAsciiListValue( [in] sequence<string> seqValue )
184 raises( com::sun::star::registry::InvalidRegistryException );
185
186 // DOCUMENTATION CHANGED FOR XRegistryKey::getStringValue
196 string getStringValue()
197 raises( com::sun::star::registry::InvalidRegistryException,
198 com::sun::star::registry::InvalidValueException );
199
208 void setStringValue( [in] string value )
209 raises( com::sun::star::registry::InvalidRegistryException );
210
211 // DOCUMENTATION CHANGED FOR XRegistryKey::getStringListValue
221 sequence<string> getStringListValue()
222 raises( com::sun::star::registry::InvalidRegistryException,
223 com::sun::star::registry::InvalidValueException );
224
232 void setStringListValue( [in] sequence<string> seqValue )
233 raises( com::sun::star::registry::InvalidRegistryException );
234
235 // DOCUMENTATION CHANGED FOR XRegistryKey::getBinaryValue
245 sequence<byte> getBinaryValue()
246 raises( com::sun::star::registry::InvalidRegistryException,
247 com::sun::star::registry::InvalidValueException );
248
257 void setBinaryValue( [in] sequence<byte> value )
258 raises( com::sun::star::registry::InvalidRegistryException );
259
275 com::sun::star::registry::XRegistryKey openKey( [in] string aKeyName )
276 raises( com::sun::star::registry::InvalidRegistryException );
277
293 com::sun::star::registry::XRegistryKey createKey( [in] string aKeyName )
294 raises( com::sun::star::registry::InvalidRegistryException );
295
301 void closeKey()
302 raises( com::sun::star::registry::InvalidRegistryException );
303
314 void deleteKey( [in] string rKeyName )
315 raises( com::sun::star::registry::InvalidRegistryException );
316
317 // DOCUMENTATION CHANGED FOR XRegistryKey::openKeys
327 sequence<com::sun::star::registry::XRegistryKey> openKeys()
328 raises( com::sun::star::registry::InvalidRegistryException );
329
330 // DOCUMENTATION CHANGED FOR XRegistryKey::getKeyNames
338 sequence<string> getKeyNames()
339 raises( com::sun::star::registry::InvalidRegistryException );
340
361 boolean createLink( [in] string aLinkName,
362 [in] string aLinkTarget )
363 raises( com::sun::star::registry::InvalidRegistryException );
364
375 void deleteLink( [in] string rLinkName )
376 raises( com::sun::star::registry::InvalidRegistryException );
377
378 // DOCUMENTATION CHANGED FOR XRegistryKey::getLinkTarget
389 string getLinkTarget( [in] string rLinkName )
390 raises( com::sun::star::registry::InvalidRegistryException );
391
392 // DOCUMENTATION CHANGED FOR XRegistryKey::getResolvedName
404 string getResolvedName( [in] string aKeyName )
405 raises( com::sun::star::registry::InvalidRegistryException );
406
407};
408
409
410}; }; }; };
411
412#endif
413
414/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
signals that the registry is invalid or an operation on the registry failed.
Definition: InvalidRegistryException.idl:32
signals that the value of the key is invalid or does not have the appropriate key type.
Definition: InvalidValueException.idl:32
makes structural information (except regarding tree structures) of a single registry key accessible.
Definition: XRegistryKey.idl:40
boolean isReadOnly()
checks if the key can be overwritten.
string KeyName
This is the key of the entry relative to its parent.
Definition: XRegistryKey.idl:49
base interface of all UNO interfaces
Definition: XInterface.idl:48
RegistryKeyType
represents all possible types of a key.
Definition: RegistryKeyType.idl:32
RegistryValueType
represents all possible types of a key value.
Definition: RegistryValueType.idl:33
Definition: Accessible.idl:22