BUILDRESOURCEFILENAME Function

Reference Guide > B Routines > BUILDRESOURCEFILENAME Function

Returns the full pathname for a specified resource file.

Usage

resource_file = BUILDRESOURCEFILENAME(file)

Input Parameter

file—The name of the resource file.

Returned Value

resource_file—A string containing the resource file path.

Keywords

Appdir—A string that specifies the application directory name. This is the directory in which the application searches for resource files, string resource files, and icon files. (Default: 'vdatools')

Subdir—A string specifying a resource file subdirectory. (Default:!Lang, whose default string is 'american')

Discussion

By default, the function looks for file first in directories specified by the environment variable WAVE_RESPATH.

note

For UNIX user’s, the WAVE_RESPATH environment variable is a colon-separated list of directories, similar to WAVE_PATH in PV‑WAVE. If not found in a WAVE_RESPATH directory, the directory <wavedir>/xres/!Lang/vdatools is searched, where <wavedir> is the main PV‑WAVE directory and !Lang represents the value of the !Lang system variable (!Lang default is 'american').

For Windows user’s, the WAVE_RESPATH environment variable is a semicolon-separated list of directories, similar to the WAVE_PATH environment variable in PV‑WAVE. If not found in a WAVE_RESPATH directory, the directory <wavedir>\xres\!Lang\vdatools is searched, where <wavedir> is the main PV‑WAVE directory and !Lang represents the value of the !Lang system variable (!Lang default is 'american').

If Subdir alone is specified, the file is searched for in:

(UNIX) <wavedir>/xres/subdir/vdatools

(WIN) <wavedir>\xres\subdir\vdatools

Where <wavedir> is the main PV-WAVE directory.

If only Appdir is specified, the application searches for resources in the following directory:

(UNIX) <wavedir>/xres/!Lang/appdir

(WIN) <wavedir>\xres\!Lang\appdir

Where <wavedir> is the main PV-WAVE directory.

If both Subdir and Appdir are specified, the application searches for resources in the following directory:

(UNIX) <wavedir>/xres/subdir/appdir

(WIN) <wavedir>\xres\subdir\appdir

Where <wavedir> is the main PV-WAVE directory.

If the file is not already in the resource database, the full pathname is returned.

Example

The following commands are taken from the code for a VDA Tool called WzMyVDA. The full pathname of the resource file for WzMyVDA is returned and is passed to the Resource keyword of WwInit.

...

resource_file = BUILDRESOURCEFILENAME('wzmyvda.ad')

top = WwInit('WzMyVDA', 'VDATools', layout, $
'DestroyCB', Shell_name = 'WzMyVDA', $
Layout_name = 'toolArea', Title = unique_name, /Form, $
ConfirmClose = 'ConfirmClose', Resource = resource_file, $
Userdata = unique_name)

...