.. highlightlang:: us

.. index:: VideoSetFileName

.. _videosetfilename:

VideoSetFileName
================

.. us.tag VideoSetFileName NOTREADYENGLISH Video-set New5503

:ref:`VideoSetFileName` sets the video file name. The file will be loaded
when the video is activated with :ref:`VideoActivate`.

.. function:: bool = VideoSetFileName(hVideo, ssFileName)

.. us.return

**Return Value**

Is TRUE (1), if the function was successful and otherwise FALSE (0).

.. us.params

**Parameters**

.. uparam:: hVideo

   Identifies the Video.

.. uparam:: ssFileName

   *ssFileName* is the complete filename. 

.. us.comment

**Comment**

The file name can be specified as a complete file name or a relative file name.
To open the file UniPlot searches in the following order for the given file.
The search ends when the file is found:

* Try to open the file with its given name.

* Search in the directory where the IPW/IPZ file is saved.

* Search the directories specified in the dialog :ref:`toolsmore-options` in
  the edit field **Searchpath for picture files**.

If the video file is not found, a box with the file name is displayed in the 
UniPlot document page.

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013.3
     - New.

.. seealso::
   :ref:`overview-videos`,
   :ref:`VideoCreate`,
   :ref:`VideoGetFileName`

:sub:`id-42978`