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

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

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

When overridden in a derived class, writes a log record to the IRecordSequence.

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

Syntax

Visual Basic

Function Append ( _
	data As ArraySegment(Of Byte), _
	nextUndoRecord As SequenceNumber, _
	previousRecord As SequenceNumber, _
	recordAppendOptions As RecordAppendOptions _
) As SequenceNumber

SequenceNumber Append(
	ArraySegment<byte> data,
	SequenceNumber nextUndoRecord,
	SequenceNumber previousRecord,
	RecordAppendOptions recordAppendOptions
)

Visual C++

SequenceNumber Append(
	ArraySegment<unsigned char> data, 
	SequenceNumber nextUndoRecord, 
	SequenceNumber previousRecord, 
	RecordAppendOptions recordAppendOptions
)

abstract 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.

Exceptions

Exception	Condition
ArgumentException	One or more of the arguments is invalid.
IOException	An I/O error occurred while appending the record.
SequenceFullException	The record sequence could not make enough free space to contain the new record.
ObjectDisposedException	The method was called after the sequence has been disposed of.

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.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

IRecordSequence Interface

Append Overload

System.IO.Log Namespace