LogRecordSequence.Append Method (ArraySegment(Byte), SequenceNumber, SequenceNumber, RecordAppendOptions) (System.IO.Log)

Switch View :
ScriptFree
.NET Framework Class Library
LogRecordSequence.Append Method (ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions)

Writes a log record to the LogRecordSequence. This method cannot be inherited.

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

Visual Basic (Declaration)
Public Function Append ( _
	data As ArraySegment(Of Byte), _
	nextUndoRecord As SequenceNumber, _
	previousRecord As SequenceNumber, _
	recordAppendOptions As RecordAppendOptions _
) As SequenceNumber
Visual Basic (Usage)
Dim instance As LogRecordSequence
Dim data As ArraySegment(Of Byte)
Dim nextUndoRecord As SequenceNumber
Dim previousRecord As SequenceNumber
Dim recordAppendOptions As RecordAppendOptions
Dim returnValue As SequenceNumber

returnValue = instance.Append(data, nextUndoRecord, _
	previousRecord, recordAppendOptions)
C#
public SequenceNumber Append(
	ArraySegment<byte> data,
	SequenceNumber nextUndoRecord,
	SequenceNumber previousRecord,
	RecordAppendOptions recordAppendOptions
)
Visual C++
public:
virtual SequenceNumber Append(
	ArraySegment<unsigned char> data, 
	SequenceNumber nextUndoRecord, 
	SequenceNumber previousRecord, 
	RecordAppendOptions recordAppendOptions
) sealed
JScript
public final function Append(
	data : ArraySegment<byte>, 
	nextUndoRecord : SequenceNumber, 
	previousRecord : SequenceNumber, 
	recordAppendOptions : RecordAppendOptions
) : SequenceNumber

Parameters

data
Type: System.ArraySegment<Byte>
A list of byte array segments that will be concatenated and appended as the record.
nextUndoRecord
Type: System.IO.Log.SequenceNumber
The sequence number of the next record in the user-specified order.
previousRecord
Type: System.IO.Log.SequenceNumber
The sequence number of the next record in Previous order.
recordAppendOptions
Type: System.IO.Log.RecordAppendOptions
A valid value of RecordAppendOptions that specifies how the data should be written.

Return Value

Type: System.IO.Log.SequenceNumber
The sequence number of the appended log record.

Implements

IRecordSequence.Append(ArraySegment<Byte>, SequenceNumber, SequenceNumber, RecordAppendOptions)
Exceptions

Exception Condition
ArgumentException

userRecord or previousRecord is not valid for this sequence.

-or-

data cannot be appended because it is larger than the maximum record size.

-or-

reservations was not created by this record sequence.

ArgumentNullException

One or more of the arguments are null.

ArgumentOutOfRangeException

userRecord or previousRecord is not between the base and last sequence numbers of this sequence.

IOException

The request could not be performed because of an unexpected I/O exception.

-or-

The request could not be performed because of an I/O device error.

NotSupportedException

The operation cannot be performed because the record sequence was opened with read-only access.

ObjectDisposedException

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

OutOfMemoryException

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

SequenceFullException

The record sequence is full.

UnauthorizedAccessException

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

Remarks

Data contained in the data parameter will be concatenated into a single byte array for appending as the record. However, no provision is made for splitting data back into array segments when the record is read.

Normally, this method completes before the record has been written. To ensure that a record has been written, either specify the ForceFlush flag using the recordAppendOptions parameter, or call the Flush method.

Examples

The following example demonstrates how to use this method to append a log record to the sequence.

.NET Framework Security

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0
See Also

Reference