.. _doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1a8c9e0ee898f39e99c29bc8b1f0174a2f:

IStoredImageHandle.RateImage Method
+++++++++++++++++++++++++++++++++++

Definition
""""""""""

*Namespace:* ``P1.CameraSdk``

Change the star-rating of an image.

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

    public void RateImage(:ref:`StarRating<doxcsid-namespace_p1_1_1_camera_sdk_1a88bbb2e30712828019f808031981130a>` rating);

All images can have an optional star-rating, to mark them as more or less significant. Use this method to change an image rating, or remove it.

Confirmation of a changed rating is provided by a notification. If you wish to receive this notification, you must listen for the :ref:`EventType.CameraImageEdited <doxcsid-class_p1_1_1_camera_sdk_1_1_event_type_1a392cbf6f5d15b49471bbc54c16e73359>` notification, *before* calling this method. If the request fails, there is no notification.

To retrieve the existing star-rating of an image you should use the methods :ref:`RequestBasicImageInfoAsync <doxcsid-interface_p1_1_1_camera_sdk_1_1_i_stored_image_handle_1aa777d52098547dd1ef87f7f9b768fe02>` or its synchronous counter part BasicImageInfo(uint).



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- rating

		- The new rating to set on the image