Request function

Macro commands may be used either in macros or by sending the commands to DPlot via dynamic data exchange (DDE). Some commands are valid only in macros (noted by Macros Only). Commands sent to DPlot via DDE must be enclosed by square brackets [     ]. Macro commands should not include the brackets.

Command parameters shown in the descriptions below are placeholders for the actual values. Command parameters are either numeric values, equations that evaluate to numbers, or character strings. Character string parameters are always bound by double quotation marks. Equations must be preceded by an equals sign (=).

The pipe symbol (|) in the command syntax indicates that a parameter is optional, and should not be included in your macro unless otherwise noted.

All indices into arrays are 1-based, e.g. Curve1=1 refers to the first curve in a plot.

A 0x prefix for numbers in the descriptions below indicates hexadecimal notation; e.g. 0x0010 = 16.

JR/Viewer indicates that the command is supported by DPlot Jr or DPlot Viewer.
JR/Viewer indicates that the command is NOT supported by DPlot Jr or DPlot Viewer.

 Request macro        Macros Only JR   Viewer

This function may be used to retrieve selected information from the currently active DPlot document, for substitution in other macro commands. Syntax:

VAR_x=Request("item")

where x is any of the uppercase letters from A to Z. VAR_x is case-specific: VAR_A will be interpreted as expected; var_a will not.

Valid items are shown below Document Topics in the Transferring DPlot data to other applications topic.

Variables will be replaced by the corresponding result in any subsequent macro command.

Example:

VAR_A=Request("ListPeaks")

TextNoteEx("VAR_A",0.5,0.5,6,5,8,0,0,-1)

will create a text notation centered horizontally and vertically at the center of the plot, containing the output of the List Peaks command.

Example:

VAR_A=Request("path")

VAR_B=Request("fname")

FileSaveAs("Portable Network Graphics","VAR_AVAR_B001.png")

If you open the DPlot file c:\my data\my dplot file.grf and run this macro, the macro will save a PNG file c:\my data\my dplot file001.png