gpeSetMapEntry

gpeSetMapEntry(
u_sandbox
l_mapEntry
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Modifies the map portion of the Modgen sandbox object by updating the symbol mapping value with the specified map entry. The key in the map is the schematic name. If the sandbox has a schematic instance with the same name as the one specified in the map entry, then the symbol mapping of that instance in the sandbox is modified.

Arguments

u_sandbox	Specifies the Modgen sandbox object.
l_mapEntry	Specifies a DPL map entry of the schematic instance name and its symbol mapping.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

t	Indicates that the Modgen sandbox object was set or modified.
nil	The command was unsuccessful.

Example

Here the two arguments for gpeSetMapEntry are first defined. sb includes the sandbox object returned by calling gpeEditSandbox. mapEntry includes the name of the map entry that is created by calling gpeCreateMapEntry. These two values are passed as arguments to gpeSetMapEntry.

sb = gpeEditSandbox() 

=> pe:0x#####

mapEntry = gpeCreateMapEntry(?schematicName "M5" ?symbolName "X")

=> (nil symbol "X" schName "M5")

gpeSetMapEntry(sb mapEntry)

=> t

Return to top