struct OpenCommandArgument in module com::sun::star::ucb::

(Global Index)

Syntax

struct OpenCommandArgument;

Description

The argument for commands like "open", "update", and "synchronize".

See also

XCommandProcessor

Field 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 XActiveDataSink , XOutputStream or XActiveDataStreamer ).

Properties The properties, for that the values shall be provided by the ContentResultSet returned by the command).

Field Details



Mode

Syntax

long Mode;

Description

A mode.

The value can be one of the OpenMode constants.


Priority

Syntax

long Priority;

Description

The command's priority, in the range 0 (highest) to 65535 (lowest).


Sink

Syntax

com::sun::star::uno::XInterface Sink;

Description

The data sink to write the contents into (supporting either XActiveDataSink , XOutputStream or 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 XInputStream . It is highly recommended that this object also implements the interface 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

Syntax

sequence< com::sun::star::beans::Property > Properties;

Description

The properties, for that the values shall be provided by the ContentResultSet returned by the command).

Top of Page