[This is preliminary documentation and is subject to change.]
This method was added in Content Studio version 5.7.
Namespace: ContentStudio
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
public string GetMEUIStructure( ConnectionId connectionId, SessionId sessionId, bool getSchema )
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
Type: StringXml that reflects the actual file system structure with folders, subfolders and files.
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>
Exception | Condition |
---|---|
NotSupportedException | The current server configuration does not allow access to resource data. |
UnauthorizedAccessException | Content Studio server does not have the required permission to access the resource. |
SecurityException | Content Studio server does not have the required permission to access the resource. |
CSInvalidSessionException | The Content Studio session is invalid. |
CSPermissionDeniedException | The caller does not have the required permission. |
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. |