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

public string GetServerStructure(
	ConnectionId connectionId,
	SessionId sessionId,
	bool getSchema
)

Public Function GetServerStructure ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	getSchema As Boolean
) As String

Parameters

connectionId

Type: ContentStudioConnectionId
A value that uniquely identifies the requested web site.

sessionId

Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).

getSchema

Type: SystemBoolean
When set to true the string representation of the XmlSchema that describes the returned xml structure is returned rather that the data itself.

Return Value

The following xml contains a small sample of this xml structure retuned by GetServerResource. To get a specific file resource a developer uses the value of the pathAndName attribute on a file element as input to the GetNamedServerResource metod to obtain the actual resource data.

<site name="MyComputer" pathAndName="" xmlns="uri://contentStudio.se/api/siteStructure">
    <folder name="Security" pathAndName="Security\">
            <!-- folders can follow-->
            <file name="Policies.xsd" pathAndName="Security\Policies.xsd" />
            <!-- more files can follow-->
    </folder>
    <!-- more folders can follow-->
    <file name="CSServer5.dll" pathAndName="CSServer5.dll" /> 
    <!-- more files can follow-->
</site>

Note
Security information To prevent Content Studio from downloading any web site resource a DWORD value named allowResourceRetrieval in the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Teknikhuset\Content Studio\5.0\Websites\NNN (where NNN is the numeric connectionid of the site) can be added and given the value 0.

Reference