CategoryManager.Rename Method

CategoryManagerRename Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Renames a category in Content Studio and in the underlying file system.

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

Syntax

public void Rename(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	string newName
)

Public Sub Rename ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId,
	newName As String
)

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).
categoryId: Type: ContentStudio.DocumentCategoryId
The identifier of the category to rename.
newName: Type: SystemString
The new category name. This name cannot be null, empty or contain any invalid filename character and cannot be in use already.

Exceptions

Exception

Condition

The specified connectionId or newName is not valid.

The operation requires at least Vista / Windows Server 2008

Number	Description
1505	The category categoryId does not exist
1508	The name cannot begin or begin with spaces.
1512	The name is already in use, choose another name.
1516	The name is is invalid.
1811	The category is protected.

Content Studio permissions

Write Container permission on the affected category is required to rename a category.

Remarks

This metod was added in CS 5.4

Requires Transactional NTFS which is present in Windows Vista / Server 2008 and later.