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

public string GetXmlMenu(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	DocumentId currentDocumentId,
	DateTime dateCriteria,
	bool performAccessCheck,
	bool usePublishStatus
)

Public Function GetXmlMenu ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	currentDocumentId As DocumentId,
	dateCriteria As DateTime,
	performAccessCheck As Boolean,
	usePublishStatus As Boolean
) As String

Parameters

connectionId

Type: ContentStudioConnectionId
A value that identifies the web site

sessionId

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

documentId

Type: ContentStudio.DocumentDocumentId
A document that acts as the menu's root document. All member documents in the menu must be child documents of this root document.

currentDocumentId

Type: ContentStudio.DocumentDocumentId
This parameter is not supported for CS running on SQL Server 2000. If this parameter is greater than 0 this method will only return the relevant part of the document hierarchy. E.g. The document itself, its immediate children. Furthermore, a check is performed to see which of those documents that have children themselves. By supplying this parameter, the performance can increase several times depending how large the hierarchy is. This parameter is only useful when rendering menus that has a tree lookalike style.

dateCriteria

Type: SystemDateTime
A DateTime that is compared with the publish date of the listed documents. Can be used when previewing documents in time. Pass MinValue to use the current date.

performAccessCheck

Type: SystemBoolean
This parameter is not supported for CS running on SQL Server 2000. This method does not return any sensitive information, therefore it is possible to turn off the access check for each document in the hierarchy to increase the performance.

usePublishStatus

Type: SystemBoolean
This parameter is not supported for CS running on SQL Server 2000. By setting this parameter to false publish date, archivedate and published will be ignored to increase performance.

Return Value

<root>
    <status>0</status>
    <statustext>Success</statustext>
    <document id="1146" cid="131" parentid="1146" name=":root:" level="1" href="">
        <data url="" data="" target="" />
        <document id="1022" cid="131" parentid="1146" name="Startsida" level="2" href="">
            <data url="" data="" target="" />
            <document id="1041" cid="131" parentid="1022" name="Nyheter" level="3" href="">
                <data url="" data="" target="" />
            </document>
        </document>
    </document>
</root>

Reference