Retrieve a list of all available pumps in a given catalog. Used for manual selection.
Namespace: configuration_servicesAssembly: configuration_services (in configuration_services.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C# |
---|
DataTable get_catalog_pumps(
int catalog_id,
List<string> columns,
string filter
) |
Visual Basic |
---|
Function get_catalog_pumps ( _
catalog_id As Integer, _
columns As List(Of String), _
filter As String _
) As DataTable |
Visual C++ |
---|
DataTable^ get_catalog_pumps(
int catalog_id,
List<String^>^ columns,
String^ filter
) |
Parameters
- catalog_id
- Type: System..::..Int32
The catalog to query
- columns
- Type: System.Collections.Generic..::..List<(Of <(<'String>)>)>
Optional: a list of pump_properties to return for each pump in the results.
By default the following are returned:
"mfg_type","synchronous_speed","size","vendor_id","impeller_id","iMinStage","iMaxStage", "pump_id".
The pump_id is is what you need to provide to add_pump when adding a pump to the list.
- filter
- Type: System..::..String
Optional: a string filter used to limit the results returned. Uses the same
syntax as .NET DataTables/DataViews. (example: "[mfg_type] = 'my_pump_type'")
Return Value
See Also