.. _doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref:

NativeMemoryRef Class
~~~~~~~~~~~~~~~~~~~~~

Definition
^^^^^^^^^^

*Namespace:* ``P1.CameraSdk``

A wrapper around a temporary reference to an block of unmanaged memory :ref:`More...<csdetails-class_p1_1_1_camera_sdk_1_1_native_memory_ref>`

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

	public class NativeMemoryRef :  Stream


.. _csdetails-class_p1_1_1_camera_sdk_1_1_native_memory_ref:

Remarks
^^^^^^^

A wrapper around a temporary reference to an block of unmanaged memory

This object references memory owned by the SDK subsystem, so you *must* :ref:`Dispose() <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a180471c04ffcf6ebb05dce9409c69288>` it as soon as you are done with it. Either manually call :ref:`Dispose() <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a180471c04ffcf6ebb05dce9409c69288>` or use a

.. code-block:: none

	using

block to ensure quick disposal of the referenced memory. (Do *not* rely on the garbage collector to eventually free the object.

Since the lower layers of this :ref:`Camera <doxcsid-class_p1_1_1_camera_sdk_1_1_camera>` SDK are written in C/C++, images are returned to CLR contexts as a reference to unmanaged memory. This allows you to avoid extranous copies of the image data.

This class implements the Stream abstract class, so you can easily stream its content to a file or other destination stream.

The method :ref:`ToArray <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1acb07baa56e89f8d5ffbeca6a86825575>` copies the entire data buffer into a byte array (

.. code-block:: none

	byte[]

). This effectively transfers (copies) the data from unmanaged memory into managed.



.. rubric:: See also:

:ref:`Camera.WaitForImage(uint) <doxcsid-class_p1_1_1_camera_sdk_1_1_camera_1a0307790fe0f00d2b07e6ef306e4ffb62>`, Camera.WaitForLiveView(uint)


Properties
^^^^^^^^^^

.. toctree::
	:hidden:

	Size <property_P1_CameraSdk_NativeMemoryRef_Size.rst>
	Pointer <property_P1_CameraSdk_NativeMemoryRef_Pointer.rst>
	Position <property_P1_CameraSdk_NativeMemoryRef_Position.rst>
	CanRead <variable_P1_CameraSdk_NativeMemoryRef_CanRead.rst>
	CanSeek <variable_P1_CameraSdk_NativeMemoryRef_CanSeek.rst>
	CanWrite <variable_P1_CameraSdk_NativeMemoryRef_CanWrite.rst>
	Length <variable_P1_CameraSdk_NativeMemoryRef_Length.rst>

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

	*
		- :ref:`Size <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1ad4ae5f0df506c9d78c0f8feb29a0d2b4>`
		- 
	*
		- :ref:`Pointer <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a8a51b548a92c3428a9d85d71c68640db>`
		- 
	*
		- :ref:`Position <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1aeffa60b25887285f7d4b81fe505bd2a2>`
		- 
	*
		- :ref:`CanRead <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a204fdad20749dfc50a36bf4802e1cd25>`
		- 
	*
		- :ref:`CanSeek <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a8b52f306a53fd8658a9ba103b334cbc7>`
		- 
	*
		- :ref:`CanWrite <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a7a8b1d1a3fc124b04c0f0386b872ae78>`
		- 
	*
		- :ref:`Length <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a3fe36a3547875fce5862ffa86cad55f4>`
		- 

Methods
^^^^^^^

.. toctree::
	:hidden:

	Flush <function_P1_CameraSdk_NativeMemoryRef_Flush.rst>
	Read <function_P1_CameraSdk_NativeMemoryRef_Read.rst>
	Seek <function_P1_CameraSdk_NativeMemoryRef_Seek.rst>
	SetLength <function_P1_CameraSdk_NativeMemoryRef_SetLength.rst>
	Write <function_P1_CameraSdk_NativeMemoryRef_Write.rst>
	ToArray <function_P1_CameraSdk_NativeMemoryRef_ToArray.rst>
	Dispose <function_P1_CameraSdk_NativeMemoryRef_Dispose.rst>

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

	* 
		- :ref:`Flush() <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a9cb91083000647a7c90c6acc2cbf9db0>`
		- 
	* 
		- :ref:`Read(byte[] buffer, int offset, int count) <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1aff17731cb58f6d42a02c4961564eaa8b>`
		- 
	* 
		- :ref:`Seek(long offset, SeekOrigin origin) <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1ab0fa19a2d2a850dff1dfc4703ee3a083>`
		- 
	* 
		- :ref:`SetLength(long value) <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1abb718a754981269142024481f70f6134>`
		- 
	* 
		- :ref:`Write(byte[] buffer, int offset, int count) <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1aa5613453326d32036eb1a3c944396c7b>`
		- 
	* 
		- :ref:`ToArray() <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1acb07baa56e89f8d5ffbeca6a86825575>`
		- 
	* 
		- :ref:`Dispose() <doxcsid-class_p1_1_1_camera_sdk_1_1_native_memory_ref_1a180471c04ffcf6ebb05dce9409c69288>`
		-