User.Remove Method (ConnectionId, SessionId, Int32)

UserRemove Method (ConnectionId, SessionId, Int32)

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,
	int userId
)

Public Sub Remove ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	userId As Integer
)

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).
userId: Type: SystemInt32
The Content Studio identifier of the user to unregister

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

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.

Reference

User Class

Remove Overload

ContentStudio.Security Namespace