FileRecordSequence.WriteRestartArea Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Writes a restart area to the FileRecordSequence.
Overloads
| WriteRestartArea(ArraySegment<Byte>, SequenceNumber, ReservationCollection) |
Writes a restart area to the FileRecordSequence. This method cannot be inherited. |
| WriteRestartArea(ArraySegment<Byte>) |
Writes a restart area to the FileRecordSequence. This method cannot be inherited. |
| WriteRestartArea(IList<ArraySegment<Byte>>) |
Writes a restart area to the FileRecordSequence. This method cannot be inherited. |
| WriteRestartArea(ArraySegment<Byte>, SequenceNumber) |
Writes a restart area to the FileRecordSequence. This method cannot be inherited. |
| WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber) |
Writes a restart area to the FileRecordSequence. This method cannot be inherited. |
| WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection) |
Writes a restart area to the FileRecordSequence. This method cannot be inherited. |
Remarks
A restart area can be used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can read a restart area and retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process.
A restart area can be read using the ReadRestartAreas method.
WriteRestartArea(ArraySegment<Byte>, SequenceNumber, ReservationCollection)
Writes a restart area to the FileRecordSequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber WriteRestartArea(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber newBaseSeqNum, System::IO::Log::ReservationCollection ^ reservations);public System.IO.Log.SequenceNumber WriteRestartArea (ArraySegment<byte> data, System.IO.Log.SequenceNumber newBaseSeqNum, System.IO.Log.ReservationCollection reservations);abstract member WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumberPublic Function WriteRestartArea (data As ArraySegment(Of Byte), newBaseSeqNum As SequenceNumber, reservations As ReservationCollection) As SequenceNumberParameters
- data
- ArraySegment<Byte>
A list of byte array segments that will be concatenated and appended as the record.
- newBaseSeqNum
- SequenceNumber
The new base sequence number. The specified sequence number must be greater than or equal to the current base sequence number.
- reservations
- ReservationCollection
A ReservationCollection that contains the reservation that should be used for this restart area.
Returns
The sequence number of the written restart area.
Implements
Exceptions
One or more of the arguments are null.
newBaseSeqNum is not between the base and last sequence numbers of this sequence.
-or-
A new or existing archive tail or base of the active log is invalid.
reservations was not created by this record sequence.
-or-
newBaseSeqNum is not valid for this sequence.
The operation cannot be performed because the record sequence was opened with read-only access.
The request cannot be performed because of an unexpected I/O exception.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
The record sequence is full.
No reservation large enough to fit data can be found in reservations.
Remarks
A restart area can be used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can read a restart area and retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process.
A restart area can be read using the ReadRestartAreas method.
When a restart area is written, the data in the byte array segments are concatenated into a single byte array for appending as the record. No provision is made for splitting data back into array segments when the restart area is read.
If a reservation is specified, the written restart area will consume space that has been previously reserved, using a reservation contained in the collection. If the method succeeds, it will consume the smallest reservation that can contain the data, and that reservation will be removed from the collection.
When this method successfully completes, the base sequence number has been updated. All log records with sequence numbers less than the new base sequence number are inaccessible.
If a record sequence has been disposed of, or if you pass an invalid argument, exceptions are thrown immediately within this operation. Errors that occurred during an asynchronous append request, for example, a disk failure during the I/O request, will result in exceptions being thrown when the EndReserveAndAppend method is called.
Applies to
WriteRestartArea(ArraySegment<Byte>)
Writes a restart area to the FileRecordSequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber WriteRestartArea(ArraySegment<System::Byte> data);public System.IO.Log.SequenceNumber WriteRestartArea (ArraySegment<byte> data);abstract member WriteRestartArea : ArraySegment<byte> -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : ArraySegment<byte> -> System.IO.Log.SequenceNumberPublic Function WriteRestartArea (data As ArraySegment(Of Byte)) As SequenceNumberParameters
- data
- ArraySegment<Byte>
A list of byte array segments that will be concatenated and appended as the record.
Returns
The sequence number of the written restart area.
Implements
Exceptions
One or more of the arguments are null.
The operation cannot be performed because the record sequence was opened with read-only access.
The request cannot be performed because of an unexpected I/O exception.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
The record sequence is full.
Remarks
A restart area can be used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can read a restart area and retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process.
A restart area can be read using the ReadRestartAreas method.
The data in the byte array segments will be concatenated into a single byte array for appending as the record. No provision is made for splitting data back into array segments when the restart area is read.
Applies to
WriteRestartArea(IList<ArraySegment<Byte>>)
Writes a restart area to the FileRecordSequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber WriteRestartArea(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data);public System.IO.Log.SequenceNumber WriteRestartArea (System.Collections.Generic.IList<ArraySegment<byte>> data);abstract member WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> -> System.IO.Log.SequenceNumberPublic Function WriteRestartArea (data As IList(Of ArraySegment(Of Byte))) As SequenceNumberParameters
- data
- IList<ArraySegment<Byte>>
A list of byte array segments that will be concatenated and appended as the record.
Returns
The sequence number of the written restart area.
Implements
Exceptions
One or more of the arguments are null.
The operation cannot be performed because the record sequence was opened with read-only access.
The request cannot be performed because of an unexpected I/O exception.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
The record sequence is full.
Remarks
A restart area can be used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can read a restart area and retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process.
A restart area can be read using the ReadRestartAreas method.
The data in the byte array segments will be concatenated into a single byte array for appending as the record. No provision is made for splitting data back into array segments when the restart area is read.
Applies to
WriteRestartArea(ArraySegment<Byte>, SequenceNumber)
Writes a restart area to the FileRecordSequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber WriteRestartArea(ArraySegment<System::Byte> data, System::IO::Log::SequenceNumber newBaseSeqNum);public System.IO.Log.SequenceNumber WriteRestartArea (ArraySegment<byte> data, System.IO.Log.SequenceNumber newBaseSeqNum);abstract member WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : ArraySegment<byte> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumberPublic Function WriteRestartArea (data As ArraySegment(Of Byte), newBaseSeqNum As SequenceNumber) As SequenceNumberParameters
- data
- ArraySegment<Byte>
A list of byte array segments that will be concatenated and appended as the record.
- newBaseSeqNum
- SequenceNumber
The new base sequence number. The specified sequence number must be greater than or equal to the current base sequence number.
Returns
The sequence number of the written restart area.
Implements
Exceptions
One or more of the arguments are null.
newBaseSeqNum is not between the base and last sequence numbers of this sequence.
-or-
A new or existing archive tail or base of the active log is invalid.
newBaseSeqNum is not valid for this sequence.
The operation cannot be performed because the record sequence was opened with read-only access.
The request cannot be performed because of an unexpected I/O exception.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
The record sequence is full.
Remarks
A restart area can be used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can read a restart area and retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process.
A restart area can be read using the ReadRestartAreas method.
When a restart area is written, the data in the byte array segments are concatenated into a single byte array for appending as the record. No provision is made for splitting data back into array segments when the restart area is read.
When this method successfully completes, the base sequence number has been updated. All log records with sequence numbers less than the new base sequence number are inaccessible.
Applies to
WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber)
Writes a restart area to the FileRecordSequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber WriteRestartArea(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber newBaseSeqNum);public System.IO.Log.SequenceNumber WriteRestartArea (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber newBaseSeqNum);abstract member WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber -> System.IO.Log.SequenceNumberPublic Function WriteRestartArea (data As IList(Of ArraySegment(Of Byte)), newBaseSeqNum As SequenceNumber) As SequenceNumberParameters
- data
- IList<ArraySegment<Byte>>
A list of byte array segments that will be concatenated and appended as the record.
- newBaseSeqNum
- SequenceNumber
The new base sequence number. The specified sequence number must be greater than or equal to the current base sequence number.
Returns
The sequence number of the written restart area.
Implements
Exceptions
One or more of the arguments are null.
newBaseSeqNum is not between the base and last sequence numbers of this sequence.
-or-
A new or existing archive tail or base of the active log is invalid.
newBaseSeqNum is not valid for this sequence.
The operation cannot be performed because the record sequence was opened with read-only access.
The request cannot be performed because of an unexpected I/O exception.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
The record sequence is full.
Remarks
A restart area can be used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can read a restart area and retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process.
A restart area can be read using the ReadRestartAreas method.
When a restart area is written, the data in the byte array segments are concatenated into a single byte array for appending as the record. No provision is made for splitting data back into array segments when the restart area is read.
When this method successfully completes, the base sequence number has been updated. All log records with sequence numbers less than the new base sequence number are inaccessible.
Applies to
WriteRestartArea(IList<ArraySegment<Byte>>, SequenceNumber, ReservationCollection)
Writes a restart area to the FileRecordSequence. This method cannot be inherited.
public:
virtual System::IO::Log::SequenceNumber WriteRestartArea(System::Collections::Generic::IList<ArraySegment<System::Byte>> ^ data, System::IO::Log::SequenceNumber newBaseSeqNum, System::IO::Log::ReservationCollection ^ reservations);public System.IO.Log.SequenceNumber WriteRestartArea (System.Collections.Generic.IList<ArraySegment<byte>> data, System.IO.Log.SequenceNumber newBaseSeqNum, System.IO.Log.ReservationCollection reservations);abstract member WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumber
override this.WriteRestartArea : System.Collections.Generic.IList<ArraySegment<byte>> * System.IO.Log.SequenceNumber * System.IO.Log.ReservationCollection -> System.IO.Log.SequenceNumberPublic Function WriteRestartArea (data As IList(Of ArraySegment(Of Byte)), newBaseSeqNum As SequenceNumber, reservations As ReservationCollection) As SequenceNumberParameters
- data
- IList<ArraySegment<Byte>>
A list of byte array segments that will be concatenated and appended as the record.
- newBaseSeqNum
- SequenceNumber
The new base sequence number. The specified sequence number must be greater than or equal to the current base sequence number.
- reservations
- ReservationCollection
A ReservationCollection that contains the reservation that should be used for this restart area.
Returns
The sequence number of the written restart area.
Implements
Exceptions
One or more of the arguments are null.
newBaseSeqNum is not between the base and last sequence numbers of this sequence.
-or-
A new or existing archive tail or base of the active log is invalid.
reservations was not created by this record sequence.
-or-
newBaseSeqNum is not valid for this sequence.
The operation cannot be performed because the record sequence was opened with read-only access.
The request cannot be performed because of an unexpected I/O exception.
The method was called after the sequence has been disposed of.
There is not enough memory to continue the execution of the program.
The record sequence is full.
No reservation large enough to fit data can be found in reservations.
Remarks
A restart area can be used to temporarily store information containing a client's last checkpoint operation. When a recovery is necessary, you can read a restart area and retrieve all the data from the last checkpoint operation. This data initializes the transaction table, dirty pages table, and open file table so they can be used in the recovery process.
A restart area can be read using the ReadRestartAreas method.
When a restart area is written, the data in the byte array segments are concatenated into a single byte array for appending as the record. No provision is made for splitting data back into array segments when the restart area is read.
If a reservation is specified, the written restart area will consume space that has been previously reserved, using a reservation contained in the collection. If the method succeeds, it will consume the smallest reservation that can contain the data, and that reservation will be removed from the collection.
When this method successfully completes, the base sequence number has been updated. All log records with sequence numbers less than the new base sequence number are inaccessible.
If a record sequence has been disposed of, or if you pass an invalid argument, exceptions are thrown immediately within this operation. Errors that occurred during an asynchronous append request, for example, a disk failure during the I/O request, will result in exceptions being thrown when the EndReserveAndAppend method is called.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for