Get any additional manufacturer-provided notes associated with the selected pump.

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

Syntax

C#
string get_pump_note(
	uint list_id,
	uint pump_state_id,
	string locale
)
Visual Basic
Function get_pump_note ( _
	list_id As UInteger, _
	pump_state_id As UInteger, _
	locale As String _
) As String
Visual C++
String^ get_pump_note(
	unsigned int list_id, 
	unsigned int pump_state_id, 
	String^ locale
)

Parameters

list_id
Type: System..::..UInt32
The id for the selection list in which the pump resides.
pump_state_id
Type: System..::..UInt32
PumpStateID column from get_list(UInt32) or return value from add_pump(UInt32, Int32, Guid).
locale
Type: System..::..String
This is here for forward compatibility. Current pump catalogs do not support localization of pump notes. Standard locale string like "en" or "fr-ca." Specifies desired localization for returned data.

Return Value

String containing the manfacturer's note. Empty String if no note exists.

See Also