Overview | Module | Use | Devguide | Index

Constants | Constants' Details

:: 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 immediately 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 sense 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 immediately after opening. This flag makes sense 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 sense only in combination with ElementModes::WRITE.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.