.. highlightlang:: us

.. _pageundostart:

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

.. index:: PageUndoStart

.. us.tag  PageUndoStart NOTREADYENGLISH PageUndo

:ref:`PageUndoStart` begins an Undo
block.

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

.. us.return

**Return Value**

*bool* If the function succeeds, the return value *bool* is
TRUE (1). If the function fails, the return value is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hPage

   Identifies the page.

.. uparam:: ssMsg

   *ssMsg* A scalar string with the Undo message.  The
   message can be specified in German and Englich. In this case the text
   must be separated by a @ sign. See example.

.. us.comment

**Comment**

An Undo block begins with the function *PageUndoStart* and
ends with the call of the function :ref:`PageUndoEnd`. All function calls
between the calls of the function :ref:`PageUndoStart` and :ref:`PageUndoEnd` will be added to one Undo/Redo step.

.. us.example

**Example**

::

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

.. seealso::
   :ref:`overview-document-pages`,
   :ref:`PageUndoEnd`

:sub:`id-700782`