include/ucbhelper/cancelcommandexecution.hxx

   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 #ifndef INCLUDED_UCBHELPER_CANCELCOMMANDEXECUTION_HXX
  21 #define INCLUDED_UCBHELPER_CANCELCOMMANDEXECUTION_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <com/sun/star/ucb/IOErrorCode.hpp>
  25 #include <ucbhelper/ucbhelperdllapi.h>
  26
  27 namespace com::sun::star {
  28     namespace uno { class Any; }
  29     namespace ucb { class XCommandEnvironment; }
  30     namespace ucb { class XCommandProcessor; }
  31 }
  32
  33 namespace ucbhelper
  34 {
  35
  36
  37 /** Cancel the execution of a command by throwing the appropriate exception.
  38     If an Interaction Handler is given with the command environment and the
  39     handler handles the exception by selecting the supplied continuation,
  40     then this function will put the original exception supplied into a
  41     css::ucb::CommandFailedException and throw the
  42     CommandFailedException. If no handler was given or the handler was not
  43     able to handle the exception, then the given exception will be thrown
  44     directly.
  45
  46     NOTE THAT THIS FUNCTION NEVER RETURNS! IT ALWAYS THROWS AN EXCEPTION!
  47
  48     @param rException is the exception describing the error to handle.
  49
  50     @param xEnv is the command environment that may contain an Interaction
  51            Handler to use before throwing the appropriate exception.
  52
  53     @throws css::uno::Exception
  54  */
  55 UCBHELPER_DLLPUBLIC void cancelCommandExecution( const css::uno::Any & rException,
  56                              const css::uno::Reference<
  57                                 css::ucb::XCommandEnvironment > &
  58                                     xEnv );
  59
  60 /** Cancel the execution of a command by throwing the appropriate exception.
  61     If an Interaction Handler is given with the command environment and the
  62     handler handles the exception by selecting the supplied continuation,
  63     then this function will put the original exception supplied into a
  64     css::ucb::CommandFailedException and throw the
  65     CommandFailedException. If no handler was given or the handler was not
  66     able to handle the exception, then the given exception will be thrown
  67     directly.
  68
  69     NOTE THAT THIS FUNCTION NEVER RETURNS! IT ALWAYS THROWS AN EXCEPTION!
  70
  71     @param eError is an IO error code.
  72
  73     @param rArgs is a sequence containing the arguments to pass along with
  74            the exception. Each IO error code can be combined with one or
  75            more additional arguments. Refer to com/sun/star/ucb/IOErroprCode.idl
  76            for details.
  77
  78     @param xEnv is the command environment that may contain an Interaction
  79            Handler to use before throwing the appropriate exception.
  80
  81     @param rMessage is a text containing additional error information.
  82            Used as debugging aid only. Passed to the member 'Message' of the
  83            uno::Exception thrown by this function.
  84
  85     @param xContext is the command processor executing the command to cancel.
  86            Used as debugging aid only. Passed to the member 'Context' of the
  87            uno::Exception thrown by this function.
  88
  89     @throws css::uno::Exception
  90  */
  91 UCBHELPER_DLLPUBLIC void cancelCommandExecution( const css::ucb::IOErrorCode eError,
  92                              const css::uno::Sequence< css::uno::Any > & rArgs,
  93                              const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv,
  94                              const OUString & rMessage = OUString(),
  95                              const css::uno::Reference< css::ucb::XCommandProcessor > & xContext = nullptr );
  96 }
  97
  98 #endif // INCLUDED_UCBHELPER_CANCELCOMMANDEXECUTION_HXX
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */