Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
The number of data deleted
The user calling this method must have the ServiceQueueAdmin user right or the the WRITECONTAINER permission on the category in question.
[This is preliminary documentation and is subject to change.]
Deletes a set of tag definition and all data stored with them. Deleting tags and data can be extremely costly or impossible if a lot of data exists for those tags.
Callers should consider deleting data using the DeleteTagData(ConnectionId, SessionId, CategoryId, Int32, Int32) method before executing this method.
The Delete method, which performs a background delete operation through the Service Manager, is the preferred method for deleting tags.
Namespace: ContentStudio.Document.EPT
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public int DeleteTagAndData( ConnectionId connectionId, SessionId sessionId, CategoryId categoryId, int tagId )
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 - tagId
- Type: SystemInt32
The tag to delete
Return Value
Type: Int32The number of data deleted
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
CSDocumentNotFoundException | The tag or the category does not exist or the tag does not exist for the specified category. |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also