XmlIndexTagsDeleteTagData Method (ConnectionId, SessionId, CategoryId, Int32, Int32) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Deletes tag data for a set of tag definitions without deleting the tag definitions themselves.

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

public int DeleteTagData(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	int batchSize,
	int[] tags
)

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).
categoryId
Type: ContentStudio.DocumentCategoryId
The category where the tags exists
batchSize
Type: SystemInt32
The number of data to delete. This parameter cannot be less than 1 or an CSException will be thrown.
tags
Type: SystemInt32
An array of tags whose data should be deleted

Return Value

Type: Int32
The number of data entries actually deleted.
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

The user calling this method must have the ServiceQueueAdmin user right or the the WRITECONTAINER permission on the category in question.
See Also

Reference