TryParse Method (Byte[], Int32, Int32, IrcStatement, IrcStatementParseResult)

IrcStatement TryParse Method ( Byte , Int32 , Int32, IrcStatement , IrcStatementParseResult )

NetIRC2 IRC Client Library for .NET

Tries to read a buffer and parse out an IRC statement. Additionally, on failure, the reason for failure is returned.

Namespace: NetIrc2.Parsing
Assembly: NetIrc2 (in NetIrc2.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public static bool TryParse(
	byte[] buffer,
	ref int offset,
	int count,
	out IrcStatement statement,
	out IrcStatementParseResult parseResult
)

public static bool TryParse(
	byte[] buffer,
	ref int offset,
	int count,
	out IrcStatement statement,
	out IrcStatementParseResult parseResult
)

Public Shared Function TryParse ( _
	buffer As Byte(), _
	ByRef offset As Integer, _
	count As Integer, _
	<OutAttribute> ByRef statement As IrcStatement, _
	<OutAttribute> ByRef parseResult As IrcStatementParseResult _
) As Boolean

Public Shared Function TryParse ( _
	buffer As Byte(), _
	ByRef offset As Integer, _
	count As Integer, _
	<OutAttribute> ByRef statement As IrcStatement, _
	<OutAttribute> ByRef parseResult As IrcStatementParseResult _
) As Boolean

public:
static bool TryParse(
	array<unsigned char>^ buffer, 
	int% offset, 
	int count, 
	[OutAttribute] IrcStatement^% statement, 
	[OutAttribute] IrcStatementParseResult% parseResult
)

public:
static bool TryParse(
	array<unsigned char>^ buffer, 
	int% offset, 
	int count, 
	[OutAttribute] IrcStatement^% statement, 
	[OutAttribute] IrcStatementParseResult% parseResult
)

static member TryParse : 
        buffer : byte[] * 
        offset : int byref * 
        count : int * 
        statement : IrcStatement byref * 
        parseResult : IrcStatementParseResult byref -> bool

static member TryParse : 
        buffer : byte[] * 
        offset : int byref * 
        count : int * 
        statement : IrcStatement byref * 
        parseResult : IrcStatementParseResult byref -> bool

Parameters

buffer: Type: System Byte
The buffer to read from.

offset: Type: System Int32
The offset to begin reading. The parser may advance this, even if parsing fails.

count: Type: System Int32
The maximum number of bytes to read.

statement: Type: NetIrc2.Parsing IrcStatement
The statement, if parsing succeeds, or null.

parseResult: Type: NetIrc2.Parsing IrcStatementParseResult
The result of parsing. On failure, this is the reason for the failure.

Return Value

true if parsing succeeded.