[This is preliminary documentation and is subject to change.]
Parses a SIF object from the binary data stream
Declaration Syntax| C# | Visual Basic | Visual C++ |
public SifElement Parse( Stream msg, IZone zone, SifParserFlags flags )
Public Function Parse ( _ msg As Stream, _ zone As IZone, _ flags As SifParserFlags _ ) As SifElement
public: SifElement^ Parse ( Stream^ msg, IZone^ zone, SifParserFlags flags )
Parameters- msg (Stream)
- The stream containing the Xml 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
Return Value A SifElement object encapsulating the message payload (e.g.
a Edustructures.SifWorks.student.StudentPersonal object)
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 |