Top of Page
- creates a unique identifier for a command.
This identifier can be used to abort the execution of the command
accociated with that identifier. Note that it is generally not
necessary to obtain a new id for each command, because commands are
executed synchronously. So the id for a command is valid again after a
command previously associated with this id has finished. In fact you
only should get one identifier per thread and assign it to every
command executed by that thread.
Also, after a call to XCommandProcessor::abort, an
identifier should not be used any longer (and instead be released by a
call to XCommandProcessor2::releaseCommandIdentifier),
because it may well abort all further calls to
To avoid ever-increasing resource consumption, the identifier
should be released via
when it is no longer used.
- a command identifier.
- executes a command.
Common command definitions can be found in the soecification of the
- Parameter aCommand
- is the command to execute.
- Parameter CommandId
- is a unique id for the command. This identifier was obtained by calling
XCommandProcessor::createCommandIdentifier. A value of
zero can be used, if the command never shall be aborted. Different
threads MUST NOT share one command identifier (except
This can easily achieved, if every thread that wants to use an
XCommandProcessor, obtains exactly one identifier
This identifier can be used for every call to
XCommandProcessor::execute done by that thread.
- Parameter Environment
- is the execution environment.
- the result according to the specification of the command.
to indicate that the command was aborted.
to indicate that two threads tried to use the same command identifier
if an error occured during the execution of the command.
|| CommandId );
- ends the command associated with the given id.
Not every command can be aborted. It's up to the implementation
to decide whether this method will actually end the processing of
the command or simply do nothing.
- Parameter CommandId
- is a unique id for the command to abort. This must be the identifier
passed to XCommandProcessor::execute for the command
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.