Parse Method (msg, zone, flags, version)

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

Parses a SIF data element into a SifElement.

Declaration Syntax

Visual Basic

Visual C++

public SifElement Parse(
	TextReader msg,
	IZone zone,
	SifParserFlags flags,
	SifVersion version
)

Public Function Parse ( _
	msg As TextReader, _
	zone As IZone, _
	flags As SifParserFlags, _
	version As SifVersion _
) As SifElement

public:
SifElement^ Parse (
	TextReader^ msg, 
	IZone^ zone, 
	SifParserFlags flags, 
	SifVersion^ version
)

Parameters

msg (TextReader): The content to parse
zone (IZone): The Zone from which the message was received, or null if not applicable or not known
flags (SifParserFlags): The flags to use for parsing
version (SifVersion): The version of SIF that will be associated with the returned object.

Return Value

A SifElement object encapsulating the message payload (e.g. a Edustructures.SifWorks.student.StudentPersonal object)

Remarks

Note:In order to be SIF Compliant, the TextReader must be set to use UTF-8 encoding

By default, SifParser uses the default version of SIF in effect for the agent when parsing messages that do not have a SIF_Message envelope. By specifying a value to this parameter, you can change the version of SIF associated with the returned object in the event there is no SIF_Message envelope present in the XML content. Note that when parsing XML content with a SIF_Message envelope, SifParser ignores this parameter and instead uses the version indicated by the Version and xmlns attributes

Exceptions

Exception	Condition
AdkParsingException	AdkParsingException is thrown if unable to parse the message
IOException	IOException is thrown if an error is reported while reading the message content

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10