.. highlightlang:: us

.. index:: AppHelpOptions

.. _apphelpoptions:

AppHelpOptions
==============

.. us.tag AppHelpOptions NOTREADYGERMAN App New5200

:ref:`AppHelpOptions` setzt bzw. liefert Optionen für die Hilfe-Ausgabe.

.. function::  svOpt = AppHelpOptions()
    bool = AppHelpOptions(ssType)
    bool = AppHelpOptions(ssType, ssURI)

.. us.return

**Returnwert**

Falls die Funktion ohne Parameter aufgerufen wird, liefert sie die aktuellen
Werte für *ssType* und *ssURI* als Array von zwei Strings (*svOpt*), sonst
liefert sie *bool*.

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

.. us.params

**Parameter**

.. uparam:: ssType

   *ssType* ist einer der folgenden Strings:

   .. list-table::
      :header-rows: 0

      * - ``"chm"``
        - Es wird HtmlHelp verwendet.
      * - ``"chm-local"``
        - Es wird HtmlHelp mit einer lokal installierten Hilfe-Datei verwendet.
      * - ``"html-local"``
        - Es wird der Standard-Web-Browser mit lokal installierten HTML-Dateien 
          verwendet.
      * - ``"html-web"``
        - Es wird der Standard-Web-Browser mit HTML-Dateien aus dem Internet oder
          Intranet.

.. uparam:: ssURI

   *ssURI* legt den Ort fest, an dem sich die Hilfe-Dateien befinden.

   Falls *ssType* gleich ``"chm"`` oder ``"chm-local"`` ist, wird *ssURI* nicht
   verwendet.

   Falls *ssType* gleich ``"html-web"`` ist, ist der Defaultwert 
   http://www.uniplot.de/documents/de/ (Deutsch) oder 
   http://www.uniplot.de/documents/en/ (Englisch).

   Falls *ssType* gleich ``"html-local"`` ist, ist der Defaultwert 
   ``"file:///" + GetRootDirectory() + "help/{LANG}/"``. ``{LANG}`` wird beim
   Aufruf der Hilfe durch ``de`` (Deutsch) oder ``en`` (Englisch) ausgetauscht.

   Falls *ssURI* gleich ``""`` ist (leerer String), wird die Default-URI
   verwendet.

.. us.comment

**Kommentar**

Falls Sie die Hilfe lokal im Web-Browser oder Firmen-Intranet verwenden möchten,
können Sie sie hier http://www.uniplot.de/documents/de/download.html downloaden.

.. us.example

**Beispiel**

Verwendung der Hilfe aus dem Internet (http://www.uniplot.de/documents/de/ oder 
http://www.uniplot.de/documents/en/) im installierten Browser (z. B. Microsoft
Internet Explorer oder Mozilla Firefox)::

   AppHelpOptions("html-web", "")

"Normale" Hilfe einschalten:: 

   AppHelpOptions("chm")

Verwendung im Intranet::

   AppHelpOptions("html-local", "http://uniplot.my-company.com/documents/{LANG}/");

Verwendung von der lokalen Festplatte, zum Beispiel::

   AppHelpOptions("html-local", "file:///D:/uniplot-documents/{LANG}/");

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - 5.20
     - Neu.

.. seealso::
   :ref:`uberblick-application-objekt`,
   :ref:`AppHelp`,
   :ref:`GetRootDirectory`,
   :ref:`GetUserDirectory`,
   :ref:`config`

:sub:`id-8055`