LibreOffice LibreOffice 25.2 SDK API Reference

XHierarchicalStorageAccess.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 embed {
23
38published interface XHierarchicalStorageAccess
39{
40 // METHODS
72 XExtendedStorageStream openStreamElementByHierarchicalName(
73 [in] string sStreamPath,
74 [in] long nOpenMode )
75 raises( ::com::sun::star::embed::InvalidStorageException,
76 ::com::sun::star::lang::IllegalArgumentException,
77 ::com::sun::star::packages::WrongPasswordException,
78 ::com::sun::star::io::IOException,
79 ::com::sun::star::embed::StorageWrappedTargetException );
80
125 XExtendedStorageStream openEncryptedStreamElementByHierarchicalName(
126 [in] string sStreamName,
127 [in] long nOpenMode,
128 [in] string sPassword )
129 raises( ::com::sun::star::embed::InvalidStorageException,
130 ::com::sun::star::lang::IllegalArgumentException,
131 ::com::sun::star::packages::NoEncryptionException,
132 ::com::sun::star::packages::WrongPasswordException,
133 ::com::sun::star::io::IOException,
134 ::com::sun::star::embed::StorageWrappedTargetException );
135
157 void removeStreamElementByHierarchicalName( [in] string sElementPath )
158 raises( ::com::sun::star::embed::InvalidStorageException,
159 ::com::sun::star::lang::IllegalArgumentException,
160 ::com::sun::star::container::NoSuchElementException,
161 ::com::sun::star::io::IOException,
162 ::com::sun::star::embed::StorageWrappedTargetException );
163
164};
165
166
167}; }; }; };
168
169/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::embed::InvalidStorageException
This exception can be thrown in case a storage is invalid.
Definition: InvalidStorageException.idl:32
com::sun::star::embed::StorageWrappedTargetException
This exception can wrap an exception thrown during XStorage methods execution.
Definition: StorageWrappedTargetException.idl:29
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::packages::NoEncryptionException
This exception can be thrown in case object is not encrypted one as expected.
Definition: NoEncryptionException.idl:27
com::sun::star::packages::WrongPasswordException
This exception can be thrown in case wrong password was provided.
Definition: WrongPasswordException.idl:27
com::sun::star::embed::XExtendedStorageStream
This interface allows access to an extended storage stream that might be transacted.
Definition: XExtendedStorageStream.idl:27
com::sun::star::embed::XHierarchicalStorageAccess
This interface allows hierarchical access to storage tree.
Definition: XHierarchicalStorageAccess.idl:39
com::sun::star::embed::XHierarchicalStorageAccess::removeStreamElementByHierarchicalName
void removeStreamElementByHierarchicalName([in] string sElementPath)
removes a stream specified by hierarchical name from a storage.
com::sun::star::embed::XHierarchicalStorageAccess::openEncryptedStreamElementByHierarchicalName
XExtendedStorageStream openEncryptedStreamElementByHierarchicalName([in] string sStreamName, [in] long nOpenMode, [in] string sPassword)
allows to get access to a child encrypted stream with password using hierarchical path.
com::sun::star::embed::XHierarchicalStorageAccess::openStreamElementByHierarchicalName
XExtendedStorageStream openStreamElementByHierarchicalName([in] string sStreamPath, [in] long nOpenMode)
allows to get access to a child stream of the storage, using hierarchical path.
com
Definition: Ambiguous.idl:20