Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Elements' Summary Elements' Details

:: com :: sun :: star :: ucb ::

struct OpenCommandArgument
Description
The argument for commands like "open", "update", and "synchronize".
See also
XCommandProcessor
Elements' Summary
Mode A mode.  
Priority The command's priority, in the range 0 (highest) to 65535 (lowest).  
Sink The data sink to write the contents into (supporting either ::com::sun::star::io::XActiveDataSink, ::com::sun::star::io::XOutputStream or ::com::sun::star::io::XActiveDataStreamer).  
Properties The properties, for that the values shall be provided by the DynamicResultSet returned by the command).  
Elements' Details
Mode
long Mode;
Description
A mode.

The value can be one of the OpenMode constants.

Priority
long Priority;
Description
The command's priority, in the range 0 (highest) to 65535 (lowest).
Sink
::com::sun::star::uno::XInterface Sink;
Description
The data sink to write the contents into (supporting either ::com::sun::star::io::XActiveDataSink, ::com::sun::star::io::XOutputStream or ::com::sun::star::io::XActiveDataStreamer).

XActiveDataSink and XOutputStream give the caller read-only access to the contents. XActiveDataStreamer offers both read and write access to the contents.

If an XActiveDataSink is supplied, the implementation of the command needs to provide an implementation of an object implementing the interface ::com::sun::star::io::XInputStream. It is highly recommended that this object also implements the interface ::com::sun::star::io::XSeekable, if this can be done without wasting resources (i.e. allocating huge memory buffers). The implementation object has to be supplied to the data sink.

Properties
sequence< ::com::sun::star::beans::Property > Properties;
Description
The properties, for that the values shall be provided by the DynamicResultSet returned by the command).
Top of Page

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.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.