.. highlightlang:: us

.. index:: DocSetPathName

.. _docsetpathname:

DocSetPathName
==============

.. us.tag  DocSetPathName ENGLISH DocSet

:ref:`DocSetPathName` sets the file name.

.. function::  bool = DocSetPathName(hDoc, ssFileName)

.. us.return

**Return Value**

If the function succeeds, the return value is TRUE (1); otherwise it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hDoc

   Identifies the document.

.. uparam:: ssFileName

   *ssFileName* is the file name. If the string is empty a default name is given
   to the document (:file:`UniPlot1`, :file:`UniPlot2`,...).

.. us.example

**Example**

::

   DocSetPathName(hDoc, "")             // Set Default Name
   DocSetPathName(hDoc, "c:/doc.ipz")   // Use forward slash or double backslash \\

.. seealso::
   :ref:`overview-documents`,
   :ref:`DocCreate`,
   :ref:`DocGetPathName`

:sub:`id-1601564`