DeviceParameterList.findValueInt Method

Module: DeviceParameterList

Definition

Searches the list for a parameter that has a specific integer value, providing a mechanism to locate parameters based on their current setting

This function is especially useful in scenarios where parameters need to be identified or grouped by their values.

find_value_int(self, value: int) -> int

Parameters

value int
in The integer value to search for among the parameters in the list

Returns

int
Outputs the index of the first device_parameter in the list whose value_as_int matches the specified search value
If no matching parameter is found, this value could be set to a sentinel value indicating ‘not found’ (e.g., -1).

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int findValueInt(int value)

Parameters

value int
in The integer value to search for among the parameters in the list

Returns

int
Outputs the index of the first device_parameter in the list whose value_as_int matches the specified search value
If no matching parameter is found, this value could be set to a sentinel value indicating ‘not found’ (e.g., -1).

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public int FindValueInt(int value)

Parameters

value int
in The integer value to search for among the parameters in the list

Returns

int
Outputs the index of the first device_parameter in the list whose value_as_int matches the specified search value
If no matching parameter is found, this value could be set to a sentinel value indicating ‘not found’ (e.g., -1).

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public int findValueInt(int value) throws DevicesException

Parameters

value int
in The integer value to search for among the parameters in the list

Returns

int
Outputs the index of the first device_parameter in the list whose value_as_int matches the specified search value
If no matching parameter is found, this value could be set to a sentinel value indicating ‘not found’ (e.g., -1).

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesDeviceParameterList_FindValueInt (
    ID3_DEVICES_DEVICE_PARAMETER_LIST hDeviceParameterList,
    int value,
    int * index)

Parameters

hDeviceParameterList ID3_DEVICES_DEVICE_PARAMETER_LIST
in Handle to the DeviceParameterList object.

value int
in The integer value to search for among the parameters in the list

index int *
out Outputs the index of the first device_parameter in the list whose value_as_int matches the specified search value

Returns

int
An error code.
See id3DevicesError file for the list of possible error codes.