Add pump identified by the string version of the pump_id (guid string) to the specified list. The list id may come from either search(design_point, UInt32, Int32, UnitSystem, optional_criteria) or new_list(design_point, UInt32, UnitSystem).

Namespace: configuration_services
Assembly: configuration_services (in configuration_services.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
uint add_pump_with_stages(
	uint list_id,
	int cat_id,
	string pump_id,
	uint stages
)
Visual Basic
Function add_pump_with_stages ( _
	list_id As UInteger, _
	cat_id As Integer, _
	pump_id As String, _
	stages As UInteger _
) As UInteger
Visual C++
unsigned int add_pump_with_stages(
	unsigned int list_id, 
	int cat_id, 
	String^ pump_id, 
	unsigned int stages
)

Parameters

list_id
Type: System..::..UInt32
Add pump to this list
cat_id
Type: System..::..Int32
Pump exists in this catalog
pump_id
Type: System..::..String
string-based pump id (guid)
stages
Type: System..::..UInt32
number of desired stages. If provided number is below minum, minimum will be returned. If provided number is above maximu, maximum will be returned. (If you don't care, or for non-multi-stage pumps, pass 1.)

Return Value

pump_state_id for the newly added pump

See Also