.. _doxcsid-class_p1_1_1_camera_sdk_1_1_sdk_exception:

SdkException Class
~~~~~~~~~~~~~~~~~~

Definition
^^^^^^^^^^

*Namespace:* ``P1.CameraSdk``

A simple subclass of the System.Exception class for SDK caused exceptions. Wraps an SDK :ref:`CameraSdk.ErrorCode <doxcsid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9>` for resolving the corresponding error. :ref:`More...<csdetails-class_p1_1_1_camera_sdk_1_1_sdk_exception>`

.. ref-code-block:: csharp
	:class: doxyrest-overview-code-block

	public class SdkException :  Exception


.. _csdetails-class_p1_1_1_camera_sdk_1_1_sdk_exception:

Remarks
^^^^^^^

A simple subclass of the System.Exception class for SDK caused exceptions. Wraps an SDK :ref:`CameraSdk.ErrorCode <doxcsid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9>` for resolving the corresponding error.

To catch any SDK related errors, you can ``try catch`` on this class. If you need to distinguish between different kind of SDK errors, you can filter on the :ref:`ErrorCode <doxcsid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a0772dc9dd27f4595ea9946471532f125>` property.

Here we use the ``when`` clause to filter specific SDK errors:

.. ref-code-block:: cpp

	try
	{
	    var camera = Camera.OpenUsbCamera();
	}
	catch(SdkException e) when (e.mErrorCode == kErrorCameraNotFound)
	{
	    Console.WriteLine($"Camera not opened, error: {e}");
	}

Here the string interpolation (``$"... error: {e}"``) uses the :ref:`ToString <doxcsid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a2110f0affc2b98eaf75e1f253e662a0a>` to print the SDK's error description.



.. rubric:: See also:

:ref:`CameraSdk.ErrorCode <doxcsid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9>`


Constructors
^^^^^^^^^^^^

.. toctree::
	:hidden:	

	SdkException <function_P1_CameraSdk_SdkException_SdkException.rst>

.. list-table::
	:widths: 30 70

	*
		- :ref:`SdkException(ErrorCode errorCode) <doxcsid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a8382aff5f4596b5c67413c32d012a4a8>`
		- Create an SDK error from an ErrorCode, with an automatically loaded description

Properties
^^^^^^^^^^

.. toctree::
	:hidden:

	ErrorCode <property_P1_CameraSdk_SdkException_ErrorCode.rst>
	ErrorMessage <property_P1_CameraSdk_SdkException_ErrorMessage.rst>

.. list-table::
	:widths: 30 70

	*
		- :ref:`ErrorCode <doxcsid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a0772dc9dd27f4595ea9946471532f125>`
		- The error code provided by the underlying SDK
	*
		- :ref:`ErrorMessage <doxcsid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a362d1bb516d08a0bc98aa4f0f3cb594b>`
		- Optional error description from the SDK

Methods
^^^^^^^

.. toctree::
	:hidden:

	ToString <function_P1_CameraSdk_SdkException_ToString.rst>

.. list-table::
	:widths: 33 67

	* 
		- :ref:`ToString() <doxcsid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a2110f0affc2b98eaf75e1f253e662a0a>`
		- A string representation of the SDK exception