getDollarParams()

The dollar parameters of the reference can be queried using this CTRL function. Only in the panel for reference configuration in GEDI. Use getDollarParamsFromPanel() for getting the dollar parameters from a panel.

Synopsis

int getDollarParams(string &refName, dyn_string &dollars, dyn_string &values);

Parameters

Parameters	Meaning
refName	returns the name of the reference
dollars	returns the $parameters of the reference
values	returns the value for the $parameters

Return value

The function returns -1 in normal operation and 0 with GEDI.

Errors

Description

The dollar parameters of a reference can be queried using this CTRL function. This function is only to be used under Windows (Module GEDI, panel for reference configuration). The panel for reference configuration opens with the script openRefParamPanel.ctl.

Example

The following example creates a simple reference editor. The editor contains a text field that displays the $parameters of the reference. Furthermore, a closing button with closeDialog() will be provided. Define this panel as reference editor for any panel containing $parameters (property: RefDefPanel). Inserting the panel with the dollars in another panel opens the simple editor and displays your $parameters. The following script runs in the background of the text field (Initialize).

main()

{

int x;

string refName;

dyn_string dollars, values;

x=getDollarParams(refName,dollars,values);

y=setValue("","text",dollars);

DebugN(refName, dollars,x);

}

This function is used by the default reference editor. The parameters will be displayed in a table and after defining the values, the function setdollarParams() sets the values.

Member of

Graphics

Availability

UI, GEDI