[This is preliminary documentation and is subject to change.]
Parses a SIF data element into a SifElement.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public SifElement Parse( TextReader msg, IZone zone )
Public Function Parse ( _ msg As TextReader, _ zone As IZone _ ) As SifElement
public: SifElement^ Parse ( TextReader^ msg, IZone^ zone )
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
Return Value A SifElement object encapsulating the message payload (e.g.
a Edustructures.SifWorks.student.StudentPersonal object)
Remarks
In order to be SIFCompliant, the TextReader must be using UTF-8 Encoding to read the underlying binary data
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 |