Language
The Free and Open Productivity Suite
:: com :: sun :: star :: embed ::
|
| constants group ElementModes |
- Description
- The constant set contains possible modes to open an element.
The modes can be combined by 'or' operation.
ElementModes::READ and ElementModes::WRITE
are base modes. A result mode must include one of base modes.
- See also
- XStorage
|
| Constants |
| READ |
specifies opening of an element for reading.
|
| SEEKABLE |
specifies opening of a seekable element.
|
| SEEKABLEREAD |
specifies opening of a seekable element for reading.
|
| WRITE |
specifies opening of an element for writing.
|
| READWRITE |
specifies opening of an element for reading and writing.
|
| TRUNCATE |
lets the document be truncated immediatelly after opening.
|
| NOCREATE |
restricts creation of a new element on opening in case a requested one
does not exist.
|
| Constants' Details |
READ
const long READ = 1;
- Description
- specifies opening of an element for reading.
|
|
SEEKABLE
const long SEEKABLE = 2;
- Description
- specifies opening of a seekable element.
This mode is ignored for Storage elements.
This flag makes sence only in combination with
ElementModes::READ and/or
ElementModes::WRITE.
|
|
SEEKABLEREAD
const long SEEKABLEREAD = 3;
- Description
- specifies opening of a seekable element for reading.
This is just a combination of the previous two values. For storages
it is the same as ElementModes::READ.
|
|
WRITE
const long WRITE = 4;
- Description
- specifies opening of an element for writing.
|
|
READWRITE
const long READWRITE = 7;
- Description
- specifies opening of an element for reading and writing.
For a stream element is also specifies that it must be seekable.
|
|
TRUNCATE
const long TRUNCATE = 8;
- Description
- lets the document be truncated immediatelly after opening.
This flag makes sence only in combination with
ElementModes::WRITE.
|
|
NOCREATE
const long NOCREATE = 16;
- Description
- restricts creation of a new element on opening in case a requested one
does not exist.
This flag makes sence only in combination with
ElementModes::WRITE.
|
|
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.
