WzExport Procedure

Starts a VDA Tool used for exporting a PV‑WAVE variable to an external file in a specified format.

Usage

WzExport, var

Input Parameters

var — The name of the variable to export.

Keywords

Directory — A string containing the name of the destination directory.

Filename — A string containing the name of the destination file.

NoBlock — If specified, the event loop (WwLoop) that is started by the VDA Tool will use the given value. By default a value of 1 (non-blocking loop) will be used. However, it may be necessary in certain circumstances to force a non-blocking loop by specifying NoBlock = 2. (See WwLoop in the PV‑WAVE Application Developer’s Guide for more information.)

Parent — The widget ID of the parent widget.

Pattern — A string containing the filter pattern for locating existing filenames within a specified directory.

Position — Specifies, in pixels, the x and y (horizontal and vertical) coordinates for the starting location of the upper-left corner of the VDA Tool window.

Restore — A data structure previously saved in the Tools Manager with the TmSaveTools function. This keyword is reserved for internal use. It is not to be used at the command line.

Template — A string containing the name of a VDA Tool template file.

Type — A string containing the type of file to be written.

Discussion

The Parent keyword is used to connect WzExport to another application, such as the Navigator.

The Restore keyword is used specifically by the TM_RESTORE method. For information on the TM_RESTORE method, refer to the source code for WzExport in:

<wavedir>/lib/vdatools/wzexport.pro

<wavedir>\lib\vdatools\wzexport.pro

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

A template is a VDA Tool with no data associated with it. The template contains all of the modifications to the VDA Tool that were set when the template file was saved. Template files are saved with the Save Template As command from the File menu on the VDA Tool.

The Type keyword specifies the format for the output file. Valid file types include the following:

ASCII-CSV (comma-separated values)

Binary

FORTRAN Binary

8 Bit Image

XOR Binary

24 Bit Image

Image

Windows DIB (Windows Only)

The names are not case sensitive. The smallest number of unique characters will be recognized. For example: Type='8 BIT'

The Filename keyword specifies the name of the output file.

The Directory keyword specifies the path to the directory in which the output file will be saved.

Note:

For information on how to use this VDA Tool, use online Help. Select the
On Window command from the VDA Tool Help menu to bring up Help on this VDA Tool.

Example

var = DIST(40)