Dws.DeleteDws Method
Deletes the current Document Workspace site and its contents.
Namespace: [DWS Web service]
Web service reference: http://Site/_vti_bin/DWS.asmx
Syntax
'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/dws/DeleteDws", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/dws/", _
ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/dws/", _
Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function DeleteDws As String
'Usage
Dim instance As Dws
Dim returnValue As String
returnValue = instance.DeleteDws()
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/dws/DeleteDws", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/dws/",
ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/dws/",
Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public string DeleteDws()
Return Value
Type: System.String
A string that returns an empty <Result/> tag when successful.
Exceptions
Exception | Condition |
---|---|
[DWSError.NoAccess(3)] | The user does not have sufficient rights. |
[DWSError.WebContainsSubwebs(11)] | The document workspace contains subsites. |
Remarks
The DeleteDws method deletes the current Document Workspace site and its contents without warning, unless the site contains subsites.
Examples
The following code example deletes the current Document Workspace site and its contents. For more information about the full text of the helper functions used in this example, see the CanCreateDwsUrl method.
Try
Dim strResult As String
strResult = dwsWebService.DeleteDws()
If IsDwsErrorResult(strResult) Then
Dim intErrorID As Integer
Dim strErrorMsg As String
Call ParseDwsErrorResult(strResult, intErrorID, strErrorMsg)
MessageBox.Show _
("A document workspace error occurred." & vbCrLf & _
"Error number: " & intErrorID.ToString & vbCrLf & _
"Error description:" & strErrorMsg, _
"DWS Error", MessageBoxButtons.OK, MessageBoxIcon.Error)
Else
MessageBox.Show _
("The document workspace was successfully deleted.", _
"Delete DWS", MessageBoxButtons.OK, _
MessageBoxIcon.Information)
End If
Catch exc As Exception
MessageBox.Show("An exception occurred." & vbCrLf & _
"Description: " & exc.Message, _
"Exception", MessageBoxButtons.OK, MessageBoxIcon.Error)
End Try
try
{
string strResult = "";
strResult = dwsWebService.DeleteDws();
if (IsDwsErrorResult(strResult))
{
int intErrorID = 0;
string strErrorMsg = "";
ParseDwsErrorResult(strResult, out intErrorID, out strErrorMsg);
MessageBox.Show
("A document workspace error occurred.\r\n" +
"Error number: " + intErrorID.ToString() + "\r\n" +
"Error description: " + strErrorMsg,
"DWS Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
}
else
{
MessageBox.Show
("The document workspace was successfully deleted.",
"Delete DWS", MessageBoxButtons.OK,
MessageBoxIcon.Information);
}
}
catch (Exception exc)
{
MessageBox.Show("An exception occurred.\r\n" +
"Description: " + exc.Message,
"Exception", MessageBoxButtons.OK, MessageBoxIcon.Error);
}