User.Remove Method (ConnectionId, SessionId, String, Int32, String)

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

Removes a registered user account from Content Studio.

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

Syntax

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

Public Sub Remove ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText 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.

Remarks

Since users are added automatically whenever they enter Content Studio this will have effect only if you know that the user is no longer using Content Studio or if the account has been deleted from the NT/Active directory security database.

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

User Class

Remove Overload

ContentStudio.Security Namespace