SiteStructureReader.Load Method

SiteStructureReaderLoad Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Loads the specified structure XML into the returned ITreeContainer.

Namespace: ContentStudio
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public static ITreeContainer Load(
	string structureXml
)

Public Shared Function Load ( 
	structureXml As String
) As ITreeContainer

structureXml: Type: SystemString
The string representation of an Xml document that describes the site or server structure to load.
This xml typically is the xml returned by GetSiteStructure(ConnectionId, SessionId, Boolean) or GetServerStructure(ConnectionId, SessionId, Boolean) methods but can be any xml data as long it follows the same schema.

Type: ITreeContainer
An ITreeContainer implementation that contains a hierarchical structures of folders and files.

Examples

For an example how to use the returned object structure see the GetSiteStructure(ConnectionId, SessionId) method.