[This is preliminary documentation and is subject to change.]
This method was added in Content Studio version 5.7.
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
public static ITreeContainer GetMEUIStructure( ConnectionId connectionId, SessionId sessionId )
Public Shared Function GetMEUIStructure ( connectionId As ConnectionId, sessionId As SessionId ) As ITreeContainer
- Type: ContentStudioConnectionId
A value that uniquely identifies the requested web site.
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Return ValueType: ITreeContainer
An ITreeContainer implementation that contains a hierarchical structures of folders and files.
|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.|
To prevent Content Studio from downloading any server 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.
Developers can use the returned information to obtain a single resource by using the GetNamedServerResource(ConnectionId, SessionId, String) method and passing the value of the PathAndName property of a leaf (file) object returned. Since the information is nested in a tree structure it is probably a good idea to consume the returned objects using series of recursive call as the example below shows.