Inherits System::IO::Stream.

Public Member Functions
virtual ASPOSECPP_SHARED_API bool	get_CanRead () ASPOSE_CONST override

virtual ASPOSECPP_SHARED_API bool	get_CanSeek () ASPOSE_CONST override

virtual ASPOSECPP_SHARED_API bool	get_CanWrite () ASPOSE_CONST override

virtual ASPOSECPP_SHARED_API int64_t	get_Length () ASPOSE_CONST override
	Returns the length of the stream in bytes. More...

virtual ASPOSECPP_SHARED_API int64_t	get_Capacity () ASPOSE_CONST
	Returns the current capacity of the underlying memory buffer. More...

virtual ASPOSECPP_SHARED_API int64_t	get_Position () ASPOSE_CONST override
	Returns the current position of the stream. More...

virtual ASPOSECPP_SHARED_API void	set_Position (int64_t value) override

ASPOSECPP_SHARED_API unsigned char *	get_PositionPointer ()
	NOT IMPLEMENTED. More...

ASPOSECPP_SHARED_API void	set_PositionPointer (unsigned char *value)
	NOT IMPLEMENTED. More...

ASPOSECPP_SHARED_API	UnmanagedMemoryStream (unsigned char *pointer, int64_t length)

ASPOSECPP_SHARED_API	UnmanagedMemoryStream (unsigned char *pointer, int64_t length, int64_t capacity, FileAccess access)

virtual ASPOSECPP_SHARED_API void	Flush () override
	Does nothing. More...

virtual ASPOSECPP_SHARED_API int	Read (ArrayPtr< unsigned char > buffer, int offset, int count) override

virtual ASPOSECPP_SHARED_API int64_t	Seek (int64_t offset, SeekOrigin loc) override

virtual ASPOSECPP_SHARED_API void	SetLength (int64_t value) override

virtual ASPOSECPP_SHARED_API void	Write (ArrayPtr< unsigned char > buffer, int offset, int count) override

Public Member Functions inherited from System::IO::Stream
virtual ASPOSECPP_SHARED_API int	ReadByte ()

virtual ASPOSECPP_SHARED_API void	WriteByte (uint8_t value)

virtual ASPOSECPP_SHARED_API int	Read (ArrayPtr< uint8_t > buffer, int offset, int count)=0

virtual ASPOSECPP_SHARED_API void	Write (ArrayPtr< uint8_t > buffer, int offset, int count)=0

virtual void	Close ()
	Closes the stream. More...

virtual ASPOSECPP_SHARED_API void	Dispose () override
	Releases all resources used by the current object and closes the stream. More...

virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResult >	BeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)

virtual ASPOSECPP_SHARED_API System::SharedPtr< System::IAsyncResult >	BeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)

virtual ASPOSECPP_SHARED_API int	EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)

virtual ASPOSECPP_SHARED_API void	EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)

virtual ASPOSECPP_SHARED_API bool	get_CanTimeout () ASPOSE_CONST
	Gets a value that determines whether the current stream can time out. More...

virtual ASPOSECPP_SHARED_API void	set_ReadTimeout (int timeout)

virtual ASPOSECPP_SHARED_API int	get_ReadTimeout () ASPOSE_CONST
	Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. More...

virtual ASPOSECPP_SHARED_API void	set_WriteTimeout (int timeout)

virtual ASPOSECPP_SHARED_API int	get_WriteTimeout () ASPOSE_CONST
	Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. More...

Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API	Object ()
	Creates object. Initializes all internal data structures. More...

virtual ASPOSECPP_SHARED_API	~Object ()
	Destroys object. Frees all internal data structures. More...

ASPOSECPP_SHARED_API	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared refernce counter. More...

ASPOSECPP_SHARED_API void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

ASPOSECPP_SHARED_API void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual ASPOSECPP_SHARED_API bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual ASPOSECPP_SHARED_API int	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual ASPOSECPP_SHARED_API String	ToString () ASPOSE_CONST
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ASPOSECPP_SHARED_API ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual ASPOSECPP_SHARED_API const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual ASPOSECPP_SHARED_API bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual ASPOSECPP_SHARED_API void	SetTemplateWeakPtr (unsigned int argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

template<>
bool	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Protected Member Functions
ASPOSECPP_SHARED_API unsigned char *	get_Pointer ()
	NOT IMPLEMENTED. More...

ASPOSECPP_SHARED_API	UnmanagedMemoryStream ()
	Constructs a new instnace of UnmanagedMemoryStream class. More...

ASPOSECPP_SHARED_API	UnmanagedMemoryStream (unsigned char *pointer, int64_t length, int64_t capacity, FileAccess access, bool skipSecurityCheck)

ASPOSECPP_SHARED_API void	Initialize (unsigned char *pointer, int64_t length, int64_t capacity, FileAccess access)

ASPOSECPP_SHARED_API void	Initialize (unsigned char *pointer, int64_t length, int64_t capacity, FileAccess access, bool skipSecurityCheck)

virtual ASPOSECPP_SHARED_API void	Dispose (bool disposing) override

Static Protected Member Functions
static ASPOSECPP_SHARED_API void	Memcpy (const ArrayPtr< unsigned char > &dest, int destIndex, unsigned char *src, int srcIndex, int len)

Protected Attributes
bool	_isOpen
	Indicates if the stream is in open state. More...

Additional Inherited Members
Public Types inherited from System::IO::Stream
typedef SharedPtr< Stream >	Ptr
	An alias for a shared pointer to this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

typedef System::Details::SharedMembersType	shared_members_type
	structure to keep list of shared pointers contained in object. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Impleemnts C# typeof(System.Object) construct. More...

Static Public Attributes inherited from System::IO::Stream
static const System::SharedPtr< Stream > ASPOSECPP_SHARED_API	Null
	A stream with no underlying storage. More...

Detailed Description

Provides access to unmanaged memory. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ UnmanagedMemoryStream() [1/4]

ASPOSECPP_SHARED_API System::IO::UnmanagedMemoryStream::UnmanagedMemoryStream	(	unsigned char *	pointer,
		int64_t	length
	)

Constructs a new instance of UnmanagedMemoryStream.

Parameters

pointer	A pointer to unmanaged buffer
length	The size of unmanaged buffer in bytes

◆ UnmanagedMemoryStream() [2/4]

ASPOSECPP_SHARED_API System::IO::UnmanagedMemoryStream::UnmanagedMemoryStream	(	unsigned char *	pointer,
		int64_t	length,
		int64_t	capacity,
		FileAccess	access
	)

Constructs a new instance of UnmanagedMemoryStream.

Parameters

pointer	A pointer to unmanaged buffer
length	The size of unmanaged buffer in bytes
capacity	The total amount of memory assigned to the stream
access	Specifies if the stream should be read-only, write-onle or both

◆ UnmanagedMemoryStream() [3/4]

ASPOSECPP_SHARED_API System::IO::UnmanagedMemoryStream::UnmanagedMemoryStream ( )

protected

Constructs a new instnace of UnmanagedMemoryStream class.

◆ UnmanagedMemoryStream() [4/4]

ASPOSECPP_SHARED_API System::IO::UnmanagedMemoryStream::UnmanagedMemoryStream	(	unsigned char *	pointer,
		int64_t	length,
		int64_t	capacity,
		FileAccess	access,
		bool	skipSecurityCheck
	)

protected

Constructs a new instance of UnmanagedMemoryStream.

Parameters

pointer	A pointer to unmanaged buffer
length	The size of unmanaged buffer in bytes
capacity	The total amount of memory assigned to the stream
access	Specifies if the stream should be read-only, write-onle or both
skipSecurityCheck	IGNORED

Member Function Documentation

◆ Dispose()

virtual ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::Dispose ( bool disposing )

overrideprotectedvirtual

Releases all resources used by the current object and closes the stream.

Parameters

disposing IGNORED

Reimplemented from System::IO::Stream.

◆ Flush()

virtual ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::Flush ( )

overridevirtual

Does nothing.

Implements System::IO::Stream.

◆ get_CanRead()

virtual ASPOSECPP_SHARED_API bool System::IO::UnmanagedMemoryStream::get_CanRead ( )

overridevirtual

Determines if the stream is readable.

Returns: True if the stream is readable; otherwise - false

Implements System::IO::Stream.

◆ get_CanSeek()

virtual ASPOSECPP_SHARED_API bool System::IO::UnmanagedMemoryStream::get_CanSeek ( )

overridevirtual

Determines if the stream supports seeking.

Returns: True if the stream supports seeking; otherwise - false

Implements System::IO::Stream.

◆ get_CanWrite()

virtual ASPOSECPP_SHARED_API bool System::IO::UnmanagedMemoryStream::get_CanWrite ( )

overridevirtual

Determines if the stream is writable.

Returns: True if the stream is writable; otherwise - false

Implements System::IO::Stream.

◆ get_Capacity()

virtual ASPOSECPP_SHARED_API int64_t System::IO::UnmanagedMemoryStream::get_Capacity ( )

virtual

Returns the current capacity of the underlying memory buffer.

◆ get_Length()

virtual ASPOSECPP_SHARED_API int64_t System::IO::UnmanagedMemoryStream::get_Length ( )

overridevirtual

Returns the length of the stream in bytes.

Implements System::IO::Stream.

◆ get_Pointer()

ASPOSECPP_SHARED_API unsigned char* System::IO::UnmanagedMemoryStream::get_Pointer ( )

protected

NOT IMPLEMENTED.

◆ get_Position()

virtual ASPOSECPP_SHARED_API int64_t System::IO::UnmanagedMemoryStream::get_Position ( )

overridevirtual

Returns the current position of the stream.

Implements System::IO::Stream.

◆ get_PositionPointer()

ASPOSECPP_SHARED_API unsigned char* System::IO::UnmanagedMemoryStream::get_PositionPointer ( )

NOT IMPLEMENTED.

◆ Initialize() [1/2]

ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::Initialize	(	unsigned char *	pointer,
		int64_t	length,
		int64_t	capacity,
		FileAccess	access
	)

protected

Initializes a newly created instance of UnmanagedMemoryStream class.

Parameters

pointer	A pointer to unmanaged buffer
length	The size of unmanaged buffer in bytes
capacity	The total amount of memory assigned to the stream
access	Specifies if the stream should be read-only, write-onle or both

◆ Initialize() [2/2]

ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::Initialize	(	unsigned char *	pointer,
		int64_t	length,
		int64_t	capacity,
		FileAccess	access,
		bool	skipSecurityCheck
	)

protected

Initializes a newly created instance of UnmanagedMemoryStream class.

Parameters

pointer	A pointer to unmanaged buffer
length	The size of unmanaged buffer in bytes
capacity	The total amount of memory assigned to the stream
access	Specifies if the stream should be read-only, write-onle or both
skipSecurityCheck	IGNORED

◆ Memcpy()

static ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::Memcpy	(	const ArrayPtr< unsigned char > &	dest,
		int	destIndex,
		unsigned char *	src,
		int	srcIndex,
		int	len
	)

staticprotected

Copies bytes from the specified source buffer starting to the specified byte array.

Parameters

dest	A byte array to copy to
destIndex	A 0-based index in `dest` at which to start writing
src	A pointer to the buffer to copy from
srcIndex	A 0-based index in `src` to start copying from
len	The number of bytes to copy

◆ Read()

virtual ASPOSECPP_SHARED_API int System::IO::UnmanagedMemoryStream::Read	(	ArrayPtr< unsigned char >	buffer,
		int	offset,
		int	count
	)

overridevirtual

Reads the specified number of bytes from the stream and writes them to the specified byte array.

Parameters

buffer	The byte array to write the read bytes to
offset	A 0-based position in `buffer` to start writing at
count	The number of bytes to read

Returns: The number of bytes read

◆ Seek()

virtual ASPOSECPP_SHARED_API int64_t System::IO::UnmanagedMemoryStream::Seek	(	int64_t	offset,
		SeekOrigin	loc
	)

overridevirtual

Sets the position of the stream represented by the current object.

Parameters

offset	The byte offset relative to a position specified by `origin`
loc	Specifies the position from which and the direction toward which the offset is calculated

Returns: The new position of the stream

Implements System::IO::Stream.

◆ set_Position()

virtual ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::set_Position ( int64_t value )

overridevirtual

Sets the stream's position.

Parameters

value The byte offset to set the stream's position to

Implements System::IO::Stream.

◆ set_PositionPointer()

ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::set_PositionPointer ( unsigned char * value )

NOT IMPLEMENTED.

◆ SetLength()

virtual ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::SetLength ( int64_t value )

overridevirtual

NOT IMPLEMENTED.

Exceptions

NotImplementedException Always

Implements System::IO::Stream.

◆ Write()

virtual ASPOSECPP_SHARED_API void System::IO::UnmanagedMemoryStream::Write	(	ArrayPtr< unsigned char >	buffer,
		int	offset,
		int	count
	)

overridevirtual

NOT IMPLEMENTED.

Exceptions

NotImplementedException Always

Member Data Documentation

◆ _isOpen

bool System::IO::UnmanagedMemoryStream::_isOpen

protected

Indicates if the stream is in open state.

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UnmanagedMemoryStream() [1/4]

◆ UnmanagedMemoryStream() [2/4]

◆ UnmanagedMemoryStream() [3/4]

◆ UnmanagedMemoryStream() [4/4]

Member Function Documentation

◆ Dispose()

◆ Flush()

◆ get_CanRead()

◆ get_CanSeek()

◆ get_CanWrite()

◆ get_Capacity()

◆ get_Length()

◆ get_Pointer()

◆ get_Position()

◆ get_PositionPointer()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ Memcpy()

◆ Read()

◆ Seek()

◆ set_Position()

◆ set_PositionPointer()

◆ SetLength()

◆ Write()

Member Data Documentation

◆ _isOpen