SetSymbol

$image\bltlrgss.gif$ Editions $image\bltlrgss.gif$ Related Transactions $image\bltlrgss.gif$ Example

The SetSymbol transaction assigns the specified symbol file to the Symbol tool. This transaction affects the Symbol tool globally, so docwinID is now ignored, but remains for backward compatibility.

Type XTYP_EXECUTE

Syntax [SetSymbol(<docwinID>, "fileName")]

Parameter	Data type	Values	Meaning
docwinID	DWORD	0	now ignored since the Symbol tool is affected globally. Optional parameter.
fileName	string	file name including path of the symbol file to use. See Remarks.

Remarks

If fileName is passed in as an empty string (""), then a dialog box will open, prompting the user for a symbol file.

Release information

Added in Release 3.60.