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

Saves one or more custom Content Studio User properties.

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

public void SetProperty(
	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 Properties are entered as a pair of parameters named PropertyName and PropertyValue. If more than one property should be saved the names and values must match and have to be separated separated by 2 pipes (||). For example to save/add two parameters named "MyApp.Data1" and "MyApp.Data2" with the values "Value 1" and "Value 2" and the email address you could specify the following XMLParameterData
<root>
<parameters>
<parameter name="Identifier">0</parameter>
<parameter name="PropertyName">MyApp.Data1||MyApp.Data2||.Email</parameter>
<parameter name="PropertyValue">Value 1||Value 2||user@company.com</parameter>
</parameters>
</root>
status
Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText
Type: SystemString
The textual representation of the call result.
Content Studio permissions

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

If the property or its application does not exist it will be created. Properties for the CS_APPLICATION cannot be created here but existing properties including the email property can be updated.
Note:
All property an application names are case sensitive.
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.
See Also

Reference