.. highlightlang:: us

.. _pageundostart:

PageUndoStart
=============

.. index:: PageUndoStart

.. us.tag  PageUndoStart GERMAN PageUndo

Mit der Funktion :ref:`PageUndoStart` beginnt ein
Undo-Block.

.. function::  bool = PageUndoStart(hPage, ssMsg)

.. us.return

**Returnwert**

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

.. us.params

**Parameter**

.. uparam:: hPage

   *hPage* ist die Zugriffsnummer einer Seite

.. uparam:: ssMsg

   *ssMsg* ist eine Zeichenkette mit der Meldung. Der
   Meldungstext kann in zwei Sprachen angegeben werden. In diesem Fall
   wird zuerst der deutsche Text angegeben, dann folgt ein @-Zeichen,
   gefolgt von einem englischen Text.

.. us.comment

**Kommentar**

Ein Undo-Block beginnt mit dem Aufruf der Funktion :ref:`PageUndoStart` und endet mit einem Aufruf der Funktion :ref:`PageUndoEnd`. Alle Funktionsaufrufe zwischen den Aufrufen der
Funktionen :ref:`PageUndoStart` und :ref:`PageUndoEnd` die eine Änderung an
der Seite mit der Zugriffsnummer *hPage* verursachen, werden zu
einem Undoschritt zusammengefaßt. Der Undoschritt wird im Menü
Bearbeiten mit dem Text *ssMsg* angezeigt.

.. us.example

**Beispiel**

::

   ssText = auto_xyz_statistic(hData);
   PageUndoStart(hPage, "3D Berechne Statistik @3D Compute statistic");
   _CreateTextObject(hPage, hLayer, ssText, TRUE);
   PageUndoEnd(hPage);

.. seealso::
   :ref:`uberblick-dokument-seiten`,
   :ref:`PageUndoEnd`

:sub:`id-700782`