SignaturePad.getParameterList Method

Module: SignaturePad

Definition

Obtains all supported parameters, optionally filtered by category.

get_parameter_list(self, category: str=None) -> DeviceParameterList

Parameters

category str
in Optional category to filter the parameters.

Returns

DeviceParameterList
Outputs the list of parameters.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
DeviceParameterList getParameterList(String? category)

Parameters

category String
in Optional category to filter the parameters.

Returns

DeviceParameterList
Outputs the list of parameters.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public DeviceParameterList GetParameterList(string category=null)

Parameters

category string
in Optional category to filter the parameters.

Returns

DeviceParameterList
Outputs the list of parameters.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public DeviceParameterList getParameterList(String category) throws DevicesException

Parameters

category String
in Optional category to filter the parameters.

Returns

DeviceParameterList
Outputs the list of parameters.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesSignaturePad_GetParameterList (
    ID3_DEVICES_SIGNATURE_PAD hSignaturePad,
    const char * category,
    ID3_DEVICES_DEVICE_PARAMETER_LIST hParameterList)

Parameters

hSignaturePad ID3_DEVICES_SIGNATURE_PAD
in Handle to the SignaturePad object.

category const char *
in Optional category to filter the parameters.

hParameterList ID3_DEVICES_DEVICE_PARAMETER_LIST
out Outputs the list of parameters.

Returns

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