DocumentReaderGetASByName Method (ConnectionId, SessionId, String, Int32, String) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Reads data for an Active Scripting component using its name.
Remarks

If more than one component exists with the same name only one of the will be returned.

Note Note
This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetASByName(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int status,
	out string statusText
)

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).
xmlParameterData
Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
status
Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText
Type: SystemString
The textual representation of the call result.

Return Value

Type: String
Xml
Copy
<root>
     <status>0</status>
     <statustext>Success</status>
     <documentid>Int32 value</documentid>
     <content>String value</content>
     <introduction>String value</introduction>
 </root>
Content Studio permissions
READ permission on the document is required.
See Also

Reference

DocumentReader Class
GetASByName Overload
ContentStudio.Document Namespace