MemoryMappedFile: CreateViewStream

CreateViewStream

Creates a stream that maps to a view of the memory-mapped file, and that has the specified offset, size, and access type.



 Public Function CreateViewStream(
	  Optional ByVal Offset As Currency,
	  Optional ByVal Size As Long,
	  Optional ByVal Access As MemoryMappedFileAccess = MemoryMappedFileAccess. ReadWrite ) As MemoryMappedViewStream

Parameters

Offset
[ByVal] Optional. Currency. The byte at which to start the view.
Size
[ByVal] Optional. Long. The size of the view. Specify 0 (zero) to create a view that starts at offset and ends approximately at the end of the memory-mapped file.
Access
[ByVal] Optional. MemoryMappedFileAccess. One of the enumeration values that specifies the type of access allowed to the memory-mapped file. The default is ReadWrite.  

Default: MemoryMappedFileAccess . ReadWrite

Return Values

MemoryMappedViewStream -  A stream of memory that has the specified characteristics.

Remarks

You can use the stream returned by this method for sequential access to a memory-mapped file, such as for inter-process communications.

To create a complete view of the memory-mapped file, specify 0 (zero) for the Size parameter. If you do this, the size of the view might be smaller or larger than the size of the source file on disk. This is because views are provided in units of system pages, and the size of the view is rounded up to the next system page size.

Exceptions

ExceptionCondition
ArgumentOutOfRangeException Offset or Size is a negative value.
-or-
Access is not a valid MemoryMappedFileAccess enumeration value.
UnauthorizedAccessExceptionAccess is invalid for the memory-mapped file.

See Also

Project CorLib Overview

Class MemoryMappedFile Overview