FileUndoHelperGetCustomHeaderAsync Method

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

Asynchronously reads the custom header bytes from a undo-index-file.

Namespace: CalculationWorks.BusinessModel.UndoSerialization
Assembly: CalculationWorks.BusinessModel.UndoSerialization (in CalculationWorks.BusinessModel.UndoSerialization.dll) Version: 4.0.0-beta7

Syntax

Copy

public static Task<byte[]> GetCustomHeaderAsync(
	Stream stream
)

Public Shared Function GetCustomHeaderAsync ( 
	stream As Stream
) As Task(Of Byte())

Parameters

stream: Type: System.IOStream
The stream.

Return Value

Type: TaskByte
A task that represents the asynchronous read operation. The value of Result will be null if the file does not contains expected format.

Exceptions

Exception	Condition
ArgumentNullException	stream is
ArgumentException	Can not read from stream; Stream is read only or closed. or Can not seek in stream; Stream is navigable.

Reference

FileUndoHelper Class

CalculationWorks.BusinessModel.UndoSerialization Namespace

FileUndoHelperAddLanguageSpecificTextSet("LSTA3C0741E_0?cpp=::|nu=.");GetCustomHeaderAsync Method

Parameters

Return Value

Reference

FileUndoHelperGetCustomHeaderAsync Method