offapi/com/sun/star/ucb/XCommandProcessor2.idl

   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 __com_sun_star_ucb_XCommandProcessor2_idl__
  21 #define __com_sun_star_ucb_XCommandProcessor2_idl__
  22
  23 #include <com/sun/star/ucb/XCommandProcessor.idl>
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** An improved version of a
  28     com::sun::star::ucb::XCommandProcessor that helps avoid
  29     ever-increasing resource consumption.
  30  */
  31 published interface XCommandProcessor2: com::sun::star::ucb::XCommandProcessor
  32 {
  33     /** releases a command identifier obtained through
  34         XCommandProcessor::createCommandIdentifier() when it is
  35         no longer used.
  36
  37         <p>After this call the command identifier cannot be used any longer in
  38         calls to XCommandProcessor::execute() and
  39         XCommandProcessor::abort().  (But it can happen that a
  40         call to XCommandProcessor::createCommandIdentifier()
  41         reuses this identifier.)</p>
  42
  43         @param CommandId
  44         A command identifier obtained through
  45         XCommandProcessor::createCommandIdentifier().  If the
  46         identifier is zero, the request is silently ignored; but if the
  47         identifier is invalid (not obtained via
  48         XCommandProcessor::createCommandIdentifier() or already
  49         handed to XCommandProcessor2::releaseCommandIdentifier()
  50         before), the behavior is undefined.
  51      */
  52     void releaseCommandIdentifier([in] long CommandId);
  53 };
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */