Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
READ permission on the document is required.
If more than one component exists with the same name only one of the will be returned.
[This is preliminary documentation and is subject to change.]
Reads data for an Active Scripting component using its name.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetASByName( ConnectionId connectionId, SessionId sessionId, string documentName )
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). - documentName
- Type: SystemString
The name of the Active Scripting component to read. This parameter cannot exceed DocumentManager.MAX_FILE_NAME_SIZE characters in size.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</status> <documentid>Int32 value</documentid> <content>String value</content> <introduction>String value</introduction> </root>
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
Remarks
See Also