CachedFileStream(String, FileMode, FileAccess, FileShare, Int32, Boolean) Constructor

public CachedFileStream(
	string path,
	FileMode mode,
	FileAccess access,
	FileShare share,
	int blockSize,
	bool useAsync
)

Public Sub New ( 
	path As String,
	mode As FileMode,
	access As FileAccess,
	share As FileShare,
	blockSize As Integer,
	useAsync As Boolean
)

public:
CachedFileStream(
	String^ path, 
	FileMode mode, 
	FileAccess access, 
	FileShare share, 
	int blockSize, 
	bool useAsync
)

new : 
        path : string * 
        mode : FileMode * 
        access : FileAccess * 
        share : FileShare * 
        blockSize : int * 
        useAsync : bool -> CachedFileStream

GSF.IO.CachedFileStream = function(path, mode, access, share, blockSize, useAsync);

Parameters

path  String

A relative or absolute path for the file that the current FileStream object will encapsulate.

mode  FileMode

A constant that determines how to open or create the file.

access  FileAccess

A constant that determines how the file can be accessed by the FileStream object. This gets the CanRead and CanWrite properties of the FileStream object. CanSeek is true if path specifies a disk file.

share  FileShare

A constant that determines how the file will be shared by processes.

blockSize  Int32

A positive Int32 value greater than 0 indicating the block size. For blockSize values between one and eight, the actual block size is set to eight bytes.

useAsync  Boolean

Specifies whether to use asynchronous I/O or synchronous I/O. However, note that the underlying operating system might not support asynchronous I/O, so when specifying true, the handle might be opened synchronously depending on the platform. When opened asynchronously, the BeginRead(Byte, Int32, Int32, AsyncCallback, Object) and BeginWrite(Byte, Int32, Int32, AsyncCallback, Object) methods perform better on large reads or writes, but they might be much slower for small reads or writes. If the application is designed to take advantage of asynchronous I/O, set the useAsync parameter to true. Using asynchronous I/O correctly can speed up applications by as much as a factor of 10, but using it without redesigning the application for asynchronous I/O can decrease performance by as much as a factor of 10.

Reference