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

(Global Index)

Syntax

struct TransferInfo;

Description

contains information needed to transfer objects from one location to another.

The transfer command is always called on the target folder. For a details description of the transfer command refer to the documentation of service Content .

Field Summary

MoveData contains the flags describing whether the data shall be moved instead of copied.

SourceURL contains the URL of the source of the action (e.g. the URL of a file to move).

NewTitle contains the title of the transferred object, if it is different from the original one.

NameClash describes how to act in case of title clashes while transferring the data.

Field Details



MoveData

Syntax

boolean MoveData;

Description

contains the flags describing whether the data shall be moved instead of copied.


SourceURL

Syntax

string SourceURL;

Description

contains the URL of the source of the action (e.g. the URL of a file to move).


NewTitle

Syntax

string NewTitle;

Description

contains the title of the transferred object, if it is different from the original one.

If this field is filled, for example, a file will be renamed while it is being transferred.


NameClash

Syntax

long NameClash;

Description

describes how to act in case of title clashes while transferring the data.

A title clash for instance occurs, if a file named "foo.txt" is to be transferred to a folder already containing another file named "foo.txt".

The value can be one of the NameClash constants.

Implementations that are not able to detect whether there is a clashing resource may ignore NameClash::ERROR and NameClash::RENAME always write the new data.

Top of Page