.. index:: pair: class; P1::CameraSdk::IImageFileCommon
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common:

class P1::CameraSdk::IImageFileCommon
=====================================

.. toctree::
	:hidden:

	enum_P1_CameraSdk_IImageFileCommon_Errors.rst

Overview
~~~~~~~~

Base class used by all image browsing related classes. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_i_image_file_common>`


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

	#include <C_P1CameraCommonStructs.h>
	
	class IImageFileCommon
	{
	public:
		// enums
	
		enum :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>`;

		// methods
	
		virtual uint32_t :ref:`ImageId<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1aa54da65815c373545187a60f0d1c1659>`() const = 0;
		virtual bool :ref:`AnyErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a7a338a7fd5c4097e9035e7e7ebbf268b>`() const = 0;
		virtual :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>` :ref:`ImageFileErrors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1ab55e830b1aeb244af2e27978100690d5>`() const = 0;
		virtual std::string :ref:`ErrorsString<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a3ed0f53f31808c058f0378bd66c25ce0>`() const = 0;
	};

	// direct descendants

	class :ref:`IImageFileBasicInfo<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info>`;
	class :ref:`ImageFileCommonImpl<doxid-class_p1_1_1_camera_sdk_1_1_image_file_common_impl>`;
	class :ref:`IPreview<doxid-class_p1_1_1_camera_sdk_1_1_i_preview>`;
	class :ref:`ITile<doxid-class_p1_1_1_camera_sdk_1_1_i_tile>`;
.. _details-class_p1_1_1_camera_sdk_1_1_i_image_file_common:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Base class used by all image browsing related classes.

Defines a common scheme to represent and query for error conditions.

:ref:`Version <doxid-struct_p1_1_1_camera_sdk_1_1_version>` 3.0

Methods
-------

.. index:: pair: function; ImageId
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1aa54da65815c373545187a60f0d1c1659:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual uint32_t ImageId() const = 0

The (session) unique image Id for this file.

.. index:: pair: function; AnyErrors
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a7a338a7fd5c4097e9035e7e7ebbf268b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual bool AnyErrors() const = 0

Returns whether the request resulted in any error(s).

.. index:: pair: function; ImageFileErrors
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1ab55e830b1aeb244af2e27978100690d5:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`Errors<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a5415589ad16ed744046e184d686d60ff>` ImageFileErrors() const = 0

The specific errors that occured.

.. index:: pair: function; ErrorsString
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_common_1a3ed0f53f31808c058f0378bd66c25ce0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual std::string ErrorsString() const = 0

A string version of the errors.