DeviceChannel.getParameterNameList Method¶
Module: DeviceChannel
Definition¶
Retrieves names of all supported parameters, optionally filtered by category.
get_parameter_name_list(self, category: str=None) -> StringList
Parameters
categorystrin Optional category to filter the parameter names.
Returns
Outputs the list of parameter names.
Exceptions
An error has occurred during Devices Library execution.
StringList getParameterNameList(String? category)
Parameters
categoryStringin Optional category to filter the parameter names.
Returns
Outputs the list of parameter names.
Exceptions
An error has occurred during Devices Library execution.
public StringList GetParameterNameList(string category=null)
Parameters
categorystringin Optional category to filter the parameter names.
Returns
Outputs the list of parameter names.
Exceptions
An error has occurred during Devices Library execution.
public StringList getParameterNameList(String category) throws DevicesException
Parameters
categoryStringin Optional category to filter the parameter names.
Returns
Outputs the list of parameter names.
Exceptions
An error has occurred during Devices Library execution.
int id3DevicesDeviceChannel_GetParameterNameList (
ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel,
const char * category,
ID3_DEVICES_STRING_LIST hParameterList)
Parameters
hDeviceChannelID3_DEVICES_DEVICE_CHANNELin Handle to the DeviceChannel object.categoryconst char *in Optional category to filter the parameter names.hParameterListID3_DEVICES_STRING_LISTout Outputs the list of parameter names.
Returns