[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( string msg, IZone zone, SifParserFlags flags, SifVersion version )
Public Function Parse ( _ msg As String, _ zone As IZone, _ flags As SifParserFlags, _ version As SifVersion _ ) As SifElement
public: SifElement^ Parse ( String^ msg, IZone^ zone, SifParserFlags flags, SifVersion^ version )
Parameters- msg (String)
- The content to parse
- zone (IZone)
- The Zone from which the message was received, or null if not applicable or not known
- flags (SifParserFlags)
- One or more FLG_ constants, or zero if no flags are applicable
- version (SifVersion)
- The version of SIF that will be associated with the returned object. 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
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 |