Versions.DeleteVersion Method

Deletes the specified file version.

Namespace:  [Versions Web service]
Web service reference: http://Site/_vti_bin/Versions.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/DeleteVersion", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function DeleteVersion ( _
    fileName As String, _
    fileVersion As String _
) As XmlNode
'Usage
Dim instance As Versions
Dim fileName As String
Dim fileVersion As String
Dim returnValue As XmlNode

returnValue = instance.DeleteVersion(fileName, _
    fileVersion)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/DeleteVersion", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public XmlNode DeleteVersion(
    string fileName,
    string fileVersion
)

Parameters

• fileName
  Type: System.String

  A string that contains the site-relative location of the folder name and file name of the file whose version is to be deleted.

• fileVersion
  Type: System.String

  A string that specifies the number of the file version to delete.

Return Value

Type: System.Xml.XmlNode
An XML fragment in the following form that can be assigned to a System.Xml.XmlNode object:

<results xmlns="https://schemas.microsoft.com/sharepoint/soap/">
   <list id="{26E516B0-8241-4B97-984D-000000000000}" />
   <versioning enabled="1" /><settings url="http://Server_Name/
         Site_Name/_layouts/1033/LstSetng.aspx?
      List={26E516B0-8241-4B97-984D-000000000000}" />
   <result version="@5" url="http://Server_Name/Site_Name/
         Shared Documents/File_Name.doc" 
      created="6/7/2003 6:28 PM" createdBy="DOMAIN\User" size="19968" 
         comments="" />
   <result version="1" url="http://Server_Name/Site_Name/
      _vti_history/1/Shared Documents/File_Name.doc" 
      created="6/7/2003 5:49 PM" createdBy="DOMAIN\User" size="19968" 
         comments="" />
      .
      .
      .
</results>

Remarks

The fileName parameter provides both file name and relative folder location, in the form folder_name/file_name. Following are examples of this parameter:

• document_library/file_name.ext

• Shared Documents/File_Name.doc

Examples

The following code example deletes the third version of a specified file.

This example requires that a using (C#) or Imports (Microsoft Visual Basic) directive be included for the System.Xml namespace.

Dim versionService As New Web_Reference_Folder_Name.Versions()
versionService.Credentials = 
   System.Net.CredentialCache.DefaultCredentials

Dim ndVersions As XmlNode = 
   versionService.DeleteVersion("Shared Documents/File_Name", "3")

MessageBox.Show(ndVersions.OuterXml)

Web_Reference_Folder_Name.Versions versionService = 
   new Web_Reference_Folder_Name.Versions();
versionService.Credentials= 
   System.Net.CredentialCache.DefaultCredentials;

XmlNode ndVersions = 
   versionService.DeleteVersion("Shared Documents/File_Name","3");

MessageBox.Show(ndVersions.OuterXml);

See Also

Reference

Versions Class

Versions Members

Versions Web Service