SK_XmlDocumentGetDocumentString Function

Retrieves the raw contents of the XML document.

Remarks

Important Note

The string returned in the content parameter must be freed from memory! The SK_StringDispose function is recommended for this purpose.

Syntax

C/C++
SK_ResultCode SK_XmlDocumentGetDocumentString(int flags, SK_XmlDoc xml, char **content);
Visual Basic
Declare Function SK_XmlDocumentGetDocumentString(ByVal flags As Long, ByVal xml As Long, ByRef content As String) As Long

Arguments

flags
Any flags passed into this function-call.
xml
The SK_XmlDoc handle.
content
Reference/pointer to a string pointer, which will point to the string which contains the XML document's contents when the call succeeds. The string pointer must be initialized to NULL (0) prior to calling this function.

Returns

All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include:

Result Code Description
SK_ResultCode.SK_ERROR_NONE No error.
SK_ResultCode.SK_ERROR_XML_PARSER_FAILED The XML parser encountered an error.
SK_ResultCode.SK_ERROR_INVALID_ARGUMENTS Some or all of the arguments are invalid.
SK_ResultCode.SK_ERROR_MEMORY_ALLOCATION Memory could not be allocated.