#87187# - Initial revision.

1 files changed, 133 insertions, 0 deletions

diff --git a/ucbhelper/inc/ucbhelper/cancelcommandexecution.hxx b/ucbhelper/inc/ucbhelper/cancelcommandexecution.hxx
new file mode 100644
index 000000000000..41964e2a8a16
--- /dev/null
+++ b/ucbhelper/inc/ucbhelper/cancelcommandexecution.hxx
@@ -0,0 +1,133 @@
+/*************************************************************************
+ *
+ *  $RCSfile: cancelcommandexecution.hxx,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: kso $ $Date: 2001-06-06 11:19:32 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef _UCBHELPER_CANCELCOMMANDEXECUTION_HXX_
+#define _UCBHELPER_CANCELCOMMANDEXECUTION_HXX_
+
+#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
+#include <com/sun/star/uno/Reference.hxx>
+#endif
+#ifndef _COM_SUN_STAR_UNO_EXCEPTION_HPP_
+#include <com/sun/star/uno/Exception.hpp>
+#endif
+#ifndef _COM_SUN_STAR_UCB_IOERRORCODE_HPP_
+#include <com/sun/star/ucb/IOErrorCode.hpp>
+#endif
+
+namespace com { namespace sun { namespace star {
+    namespace uno { class Any; }
+    namespace ucb { class XCommandEnvironment; class XContent; }
+} } }
+
+namespace ucbhelper
+{
+
+//============================================================================
+/** Cancel the execution of a command by throwing the appropriate exception.
+    If an Interaction Handler is given with the command environment and the
+    handler handles the exception by selecting the supplied continuation,
+    then this function will put the original exception supplied into a
+    com::sun::star::ucb::CommandFailedException and throw the
+    CommandFailedException. If no handler was given or the handler was not
+    able to handle the exception, then the given exception will be thrown
+    directly.
+
+    NOTE THAT THIS FUNCTION NEVER RETURNS! IT ALWAYS THROWS AN EXCEPTION!
+
+    @param rException is the exception describing the error to handle.
+
+    @param xEnv is the command environment that may contain an Interaction
+           Handler to use before throwing the appropriate exception.
+ */
+void cancelCommandExecution( const com::sun::star::uno::Any & rException,
+                             const com::sun::star::uno::Reference<
+                                com::sun::star::ucb::XCommandEnvironment > &
+                                    xEnv )
+    throw( com::sun::star::uno::Exception );
+
+/** Cancel the execution of a command by throwing the appropriate exception.
+    If an Interaction Handler is given with the command environment and the
+    handler handles the exception by selecting the supplied continuation,
+    then this function will put the original exception supplied into a
+    com::sun::star::ucb::CommandFailedException and throw the
+    CommandFailedException. If no handler was given or the handler was not
+    able to handle the exception, then the given exception will be thrown
+    directly.
+
+    NOTE THAT THIS FUNCTION NEVER RETURNS! IT ALWAYS THROWS AN EXCEPTION!
+
+    @param xContent is the UCB content executing the command to cancel.
+
+    @param eError is an IO error code.
+
+    @param xEnv is the command environment that may contain an Interaction
+           Handler to use before throwing the appropriate exception.
+ */
+void cancelCommandExecution( const com::sun::star::uno::Reference<
+                                com::sun::star::ucb::XContent > & xContent,
+                             const com::sun::star::ucb::IOErrorCode eError,
+                             const com::sun::star::uno::Reference<
+                                com::sun::star::ucb::XCommandEnvironment > &
+                                    xEnv )
+    throw( com::sun::star::uno::Exception );
+}
+
+#endif // _UCBHELPER_CANCELCOMMANDEXECUTION_HXX_