[This is preliminary documentation and is subject to change.]

Namespace:  Phoenix.Logging
Assembly:  PhoenixShared (in PhoenixShared.dll) Version: 0.7.0.0

Syntax

         
 C#  Visual Basic  Visual C++ 
public static Stream OpenFile(
	string path,
	bool autoAddIndex,
	string archivePath,
	int maxSize
)
Public Shared Function OpenFile ( _
	path As String, _
	autoAddIndex As Boolean, _
	archivePath As String, _
	maxSize As Integer _
) As Stream
public:
static Stream^ OpenFile(
	String^ path, 
	bool autoAddIndex, 
	String^ archivePath, 
	int maxSize
)

Parameters

path
String
Default path to log file.
autoAddIndex
Boolean
If true index is added to filename when it cant be opened.
archivePath
String
When non-null and file size is greater then maxSize, file is compressed to this file and original is deleted.
maxSize
Int32
Maximum size of file before it is archived, in bytes. If archivePath is null, parameter is ingored. If it is -1, no archiving is done either.

Return Value

Stream containing opened file.

See Also