.. highlightlang:: us

.. index:: DocDestroy

.. _docdestroy:

DocDestroy
==========

.. us.tag  DocDestroy GERMAN Changed5410

:ref:`DocDestroy` schließt ein Dokument.

.. function::  bool = DocDestroy(hDoc)
               bool = DocDestroy(hDoc, options)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Funktion erfolgreich war und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: hDoc

   *hDoc* ist die Zugriffsnummer des mit :ref:`DocCreate` erzeugten Dokuments.

.. uparam:: options

   Der *options* Parameter legt die Packoptionen bei IPZ-Dateien fest. Für 
   IPW-Dateien hat der Parameter keine Bedeutung.

   .. list-table::
      :widths: 40 60
      :header-rows: 1

      * - Wert
        - Beschreibung
      * - DOC_CLOSE_DEFAULT (0)
        - Default. Beim Speichern von IPZ-Dateien wird der Registry-Eintrag
          ``Settings\ipz-pack-on-close`` ausgewertet. Falls der Wert nicht
          vorhanden ist, oder den Wert 1 hat, wird die Datei über einen externen
          Prozess gepackt.
      * - DOC_CLOSE_NOPACK (1)
        - Kein Packen. Die Datei wird geschlossen und es kann sofort wieder
          auf die Datei zugegriffen werden.
      * - DOC_CLOSE_PACK_EXTERNAL (2)
        - Packen über externen Prozess. Während der externe Prozess die Datei
          packt, kann kein anderer Prozess auf die Datei zugreifen.
      * - DOC_CLOSE_PACK_INTERNAL (3)
        - Packen über internen Prozess.

.. us.comment

**Kommentar**

* IPZ-Dateien sind fast immer kleiner als IPW-Dateien, weil IPZ-Dateien 
  komprimiert sind.

* Ob eine IPZ-Datei gepackt ist, hat keinen Einfluß auf die Geschwindigkeit beim
  Öffnen und Bearbeiten.

* Beim Packen werden doppelte Kanäle entfernt. Existiert zum Beipiel auf Seite-1
  der Datensatz (n1, p1) und auf Seite-10 der Datensatz (n1, p2), wird ein Kanal
  n1 aus der Datei gelöscht. Dabei wird nicht auf die Kanalnamen geachtet,
  sondern nur auf die Werte der Kanäle. Ausserdem werden nicht mehr verwendete
  Seiten, Datensätze, Bitmaps, Maps, OLE-Objekte gelöscht.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Beschreibung
   * - R2012.10
     - Neuer Parameter *options*.

.. seealso::
   :ref:`uberblick-dokumente`,
   :ref:`DocCreate`

:sub:`id-1109992`