ParseCommonHeader Method (buffer, offset, length)

Parses a common header instance that implements ICommonHeader for the output type represented in the binary image.

Declaration Syntax

Visual Basic

Visual C++

protected override ICommonHeader<int> ParseCommonHeader(
	byte[] buffer,
	int offset,
	int length
)

Protected Overrides Function ParseCommonHeader ( _
	buffer As Byte(), _
	offset As Integer, _
	length As Integer _
) As ICommonHeader(Of Integer)

protected:
virtual ICommonHeader<int>^ ParseCommonHeader(
	array<unsigned char>^ buffer, 
	int offset, 
	int length
) override

Parameters

buffer (array<Byte>[]()[][]): Buffer containing data to parse.

offset (Int32): Offset index into buffer that represents where to start parsing.

length (Int32): Maximum length of valid data from offset.

Return Value

The ICommonHeader which includes a type ID for the Type to be parsed.

Remarks

Derived classes need to provide a common header instance (i.e., class that implements ICommonHeader) for the output types; this will primarily include an ID of the Type that the data image represents. This parsing is only for common header information, actual parsing will be handled by output type via its Initialize(array<Byte>[]()[][], Int32, Int32) method. This header image should also be used to add needed complex state information about the output type being parsed if needed.

If there is not enough buffer available to parse common header (as determined by length), return null. Also, if the protocol allows frame length to be determined at the time common header is being parsed and there is not enough buffer to parse the entire frame, it will be optimal to prevent further parsing by returning null.

Assembly: TVA.PhasorProtocols (Module: TVA.PhasorProtocols) Version: 1.4.192.0