LogStore Constructor (String, FileMode, FileAccess, FileShare, FileSecurity)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of the LogStore class.

Namespace:   System.IO.Log
Assembly:  System.IO.Log (in System.IO.Log.dll)

public LogStore(
	string path,
	FileMode mode,
	FileAccess access,
	FileShare share,
	FileSecurity fileSecurity


Type: System.String

A relative or absolute path for the base file of the log store to open.

Type: System.IO.FileMode

One of the FileMode values that determines how to open or create the store.

Type: System.IO.FileAccess

One of the FileAccess values that determines how the file can be accessed by the LogStore.

Type: System.IO.FileShare

One of the FileShare values that determines how the log store will be shared among processes.

Type: System.Security.AccessControl.FileSecurity

One of the FileSecurity value that specifies the security to set on the newly created store if the store must be created.

Exception Condition

path is null.


The log store file name specified by path is not valid.


Mode is CreateNew, which cannot be used without write access.


Mode is OpenOrCreate, which cannot be used without write access.


mode contains an invalid value.


access contains an invalid value.


share contains an invalid value.


The file cannot be found.


An I/O error occurs when opening the log store.

The file specified by path cannot be accessed because it is in use by another process.


The file specified by path cannot be created because the file or directory already exists.


The log handle could not be bound to the thread pool.


The specified log file format or version is invalid.


LogStore cannot be used because the required Common Log File System (CLFS) component is not installed. Install the CLFS component if it is available for your platform or use the FileRecordSequence class instead.


The method was called after the sequence has been disposed of.


There is not enough memory to continue the execution of a program.


The record sequence is full.


Access for the specified log store is denied by the operating system.

This constructor initializes a new LogStore object that it opens with the specified path, mode, and access. The store is opened sharing the specified access. The path parameter should follow the following syntax:

log:<physical log name>[::<log client name>]

where <physical log name> is a valid path to a log file, and <log client name> is a unique client identifier. A log store should be either a physical log store or a virtual log store, but not both. Once a log store has been created physically or virtually, it remains so for its lifetime. A physical log store is created by specifying only the physical log name. A virtual log store is created by specifying both the physical log name and the log client name.

Clients that share the same physical log name share the same extents collection and policy.

.NET Framework
Available since 3.0
Return to top