.. highlightlang:: us

.. index:: ImageSetFileName

.. _imagesetfilename:

ImageSetFileName
================

.. us.tag  ImageSetFileName NOTREADYENGLISH New360 Image ImageSet

:ref:`ImageSetFileName` sets the file name of the picture and loads the file into
the picture object.

.. function::  bool = ImageSetFileName(hImg, ssNewFileName)

.. us.return

**Return Value**

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

.. us.params

**Parameters**

.. uparam:: hImg

   Identifies the image.

.. uparam:: ssNewFileName

   *ssNewFileName* is the file name the linked file.

.. 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 picture file is not found a box with the file name is displayed in the 
UniPlot document page.

.. seealso::
   :ref:`overview-pictures`,
   :ref:`ImageGetFileName`

:sub:`id-134981`