.. highlightlang:: us

.. index:: DocSetScript

.. _docsetscript:

DocSetScript
============

.. us.tag  DocSetScript GERMAN DocSet New5402

:ref:`DocSetScript` kopiert ein Skript in ein UniPlot-Dokument, dass beim Öffnen
der Datei ausgeführt wird.

.. function::  bool = DocSetScript(hDoc, ssScript)

.. 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:: ssScript

   *ssScript* ist ein Text mit UniScript-Anweisungen.

.. us.comment

**Kommentar**

Mit dieser Funktion kann ein Text mit UniScript-Anweisungen und Funktionen in
ein UniPlot-Dokument kopiert werden.

Wird eine UniPlot-Datei mit UniPlot geöffnet, z. B. durch Doppelklicken im
Windows Explorer, durch den Befehl :ref:`file-open` oder durch Auswahl der
``.ipw``- oder ``.ipz``-Datei aus der Liste der zuletzt geöffneten Dateien, wird
der mit dieser Funktion gesetzte Code ausgeführt.

Es werden folgende Aktionen durchgeführt:

* Die Datei wird mit :ref:`DocCreate` geöffnet.

* Es wird das Skript mit :ref:`DocGetScript` geladen.

* Es wird eine Sicherheitsabfrage durchgeführt, ob das Skript geladen und
  ausgeführt werden soll. Bestätigen Sie die Ausführung nur, wenn das
  UniPlot-Dokument aus einer sicheren Quelle stammt, Sie die Datei also selbst
  erzeugt haben oder Ihnen der Ersteller der Datei bekannt ist. Ansonsten könnte
  der Code unerwünschte Aktionen ausführen (Makro-Viren).

* Das Skript wird mit :ref:`evalp` ausgeführt. Falls das Skript einen Fehler
  enthält, wird ein Meldungsfenster ausgegeben.

Unter :ref:`edit-object-properties` wird gezeigt, wie ein Skript an ein Textfeld
oder eine Schaltfläche gebunden werden kann.

**Sicherheit**: Die Funktion zum Ausführen des Codes, verwendet die Funktion::

   nSecurity = GetProfileInt_Policy("Settings", "macro-security", 0);

zur Abfrage der Sicherheitseinstellungen. Folgende Werte werden verwendet:

* 0 - question: Defaulteinstellung. Es wird ein Meldungsfenster beim Öffnen der
  Datei ausgegeben. Sie können entscheiden ob die Skripte ausgeführt werden, oder
  ob die UniPlot-Datei ohne Ausführung des Skriptes geöffnet wird.

* 1 - never: Die Skripte werden beim Öffnen von UniPlot-Dateien niemals
  ausgeführt. Es wird eine Log-Message ausgegeben, wenn eine UniPlot-Datei Makros
  enthält.

* 2 - always: Führt Macros immer ohne Rückfrage aus. Verwenden Sie diese
  Einstellung nur, wenn Sie UniPlot-Dokumente ausschließlich aus sicheren Quellen
  verwenden.

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2012.2 (5.40.2)
     - Neu.

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

:sub:`id-1433913`