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

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, String, Int32, String) 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
Copy
public int DeleteTagAndData(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int status,
	out string statusText
)

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.

Return Value

Type: Int32
The number of data deleted
Content Studio permissions
The user calling this method must have the ManageXmlIndex user right or the the WRITECONTAINER permission on the category in question.
Remarks
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.
See Also

Reference

XmlIndexTags Class
DeleteTagAndData Overload
ContentStudio.Document.EPT Namespace