SearchEquipment

Search for equipment by name.

Function

void SearchEquipment(startsWith: string, maxResults: number)

Parameters

  • startsWith (string): return all equipment with names starting with this string
  • maxResults (number): maximum number of results to return. Defaults to 10

Return Value

Returns an ordered array of strings with matching equipment names.

Example

Get the first 20 equipment names starting with “bag”:

SYM3.SearchEquipment("bag", 20)

/*
Returns: 
[
	'BAGgate_CIA01', 
	'BAGgate_CIA02', 
	'BAGgate_CIA03', 
	'BAGgate_CIA04', 
	'BAGgate_CIA05', 
	'BAGgate_CIA06', 
	'BAGgate_CIB01', 
	'BAGgate_CIB02', 
	'BAGgate_CIB03', 
	'BAGgate_CIB04', 
	'BAGgate_CIB05', 
	'BAGgate_CIB06', 
	'BAGgate_CIC01', 
	'BAGgate_CIC02', 
	'BAGgate_CIC03', 
	'BAGgate_CIC04', 
	'BAGgate_CIC05', 
	'BAGgate_CIC06', 
	'BAGgate_CID01', 
	'BAGgate_CID02'
]
*/