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