UserProperties.GetProperty Method (ConnectionId, SessionId, String, Int32, String)

UserPropertiesGetProperty 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.]

Gets a custom Content Studio User property.

Namespace: ContentStudio.Security
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public string GetProperty(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int status,
	out string statusText
)

Public Function GetProperty ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) 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).
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 in the format:

Copy

<root>
 <status>0</status>
 <statustext>Success</statustext>
 <value>Property value</value>
</root>

Content Studio permissions

A user can always work with her own data. For other accounts the caller must have the GlobalGroupAdmin user right.

Remarks

All property an application names are case sensitive.
The GetApplicationProperties(ConnectionId, SessionId, String, TrusteeUserIdentifiers, String) method performs the same operations as GetProperty method but is much more simpler and more efficient.

Remarks

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.

Reference

UserProperties Class

GetProperty Overload

ContentStudio.Security Namespace