gpeGetGridEntry

gpeGetGridEntry(
u_sandbox
[ ?ref d_refID ]
[ ?index l_index ]
[ ?name t_layoutName ]
[ ?verbose { t | nil } ]
)
=> l_gridEntry / nil

Description

Returns a grid entry that matches the specified argument for the specified sandbox object. When calling this function, only one search argument of type reference, index, or layout name must be specified. If multiple arguments are specified, an error message is displayed.

Arguments

u_sandbox	Specifies the Modgen sandbox object.
?ref d_refID	Specifies the reference database instance ID of the grid entry.
?index l_index
	Specifies the index list containing a grid row and column, for example list(0 0).
?name t_layoutName
	Specifies the layout name of the grid entry.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

l_gridEntry	Returns the Modgen grid entry (DPL) that matches the specified arguments.
nil	The command was unsuccessful.

Examples

Gets the grid entry that has a matching reference ID.

sb = gpeEditSandbox() 

window = hiGetCurrentWindow()

cv = deOpenCellView(window)

inst = dbFindAnyInstByName(cv "|M9")

gpeGetGridEntry(sb ?ref inst)

Gets the grid entry that has a matching grid index.

gpeGetGridEntry(sb ?index list(1 1))

Gets the grid entry that has a matching layout name.

gpeGetGridEntry(sb ?name "|M9")

Return to top