Imaging.Delete Method

  • Article

Removes the specified files and folders (items) from the specified list on the current Web site.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/ois/Delete", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/ois/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/ois/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function Delete ( _
    strListName As String, _
    strFolder As String, _
    itemFileNames As String() _
) As XmlNode
'Usage
Dim instance As Imaging
Dim strListName As String
Dim strFolder As String
Dim itemFileNames As String()
Dim returnValue As XmlNode

returnValue = instance.Delete(strListName, _
    strFolder, itemFileNames)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/ois/Delete", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/ois/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/ois/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public XmlNode Delete(
    string strListName,
    string strFolder,
    string[] itemFileNames
)

Parameters

  • strListName
    Type: System.String

    The name of the list in the current site.

  • strFolder
    Type: System.String

    The relative path from the root of the list to the target folder.

  • itemFileNames
    Type: []

    An array of the name of files and folders (items) to be deleted from the list.

Return Value

Type: System.Xml.XmlNode
A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following.

<results xmlns="https://schemas.microsoft.com/sharepoint/soap/ois/">
  <result name="filename1" deleted="true"/>
  <result name="filename2" deleted="false"/>
  .
  .
  .
</results>

Exceptions

Exception Condition
[0x1]

ListNotFound: The requested list is not found.
[0x2]

IsNotLibrary: The requested list, although found, is not a picture library.
[0x3]

ItemNotFound: The requested list item is not found.
[0x4]

FolderNotFound: The requested folder is not found.
[0x5]

InvalidArgument: One or more arguments are not valid.
[0x6]

FileExists: The file already exists, and the user does not specify the overwrite option.

Examples

The following example deletes the following image file from the "My Pictures" picture library: http://MyServer/sites/mynewsite/MyPictures/1/Red Figure2.gif.

Note

This code assumes that the site and picture library already exist, and that you have permissions on the server. If the site and picture library do not exist, see the second example.

Dim imgws As New Web_Reference.Imaging()
imgws.Credentials = System.Net.CredentialCache.DefaultCredentials
imgws.Url = "http://MyServer/sites/mynewsite/_vti_bin/imaging.asmx"
Dim a2(0) As String
a2(0) = "Red Figure2.gif"
imgws.Delete("My Pictures", "1", a2)

Web_Reference.Imaging imgws = new Web_Reference.Imaging();
imgws.Credentials = System.Net.CredentialCache.DefaultCredentials;
imgws.Url = "http://MyServer/sites/mynewsite/_vti_bin/imaging.asmx";
String[] a2 = new String[1];
a2[0]="Red Figure2.gif";
imgws.Delete("My Pictures","1",a2);

This example shows how to create the site and the picture library, and add the image "Red Figure2.gif" required in the preceding example.

Note

You must be a member of the Administrator site group on the server that is running Microsoft Windows SharePoint Services to be able to add a reference to the Admin Web service and perform the required actions.

Dim adminws As New Web_Reference.Admin()
adminws.Credentials = System.Net.CredentialCache.DefaultCredentials
Try
    adminws.CreateSite("http://MyServer/sites/my2003site", 
        "My 2003 New Site", _
        "Manage content and pictures for year 2003", 1033, "MPS#0", 
        "User_Alias", "Display_Name", _
        "someone@example.com", "", "")
    Catch ex As Exception
        MessageBox.Show(ex.Message)
End Try

Dim listsws As New Web_Reference.Lists()
listsws.Credentials = System.Net.CredentialCache.DefaultCredentials
listsws.Url = "http://MyServer/sites/mynewsite/_vti_bin/lists.asmx"
Try
    listsws.AddList("My Pictures", "My personal pictures", 109)
    Catch ex1 As Exception
        MessageBox.Show(ex1.Message)
End Try

Dim imgws As New Web_Reference.Imaging()
imgws.Credentials = System.Net.CredentialCache.DefaultCredentials
imgws.Url = "http://MyServer/sites/mynewsite/_vti_bin/imaging.asmx"
Dim resdoc As New System.Xml.XmlDocument()
Dim resnode As System.Xml.XmlNode = 
    resdoc.CreateNode(System.Xml.XmlNodeType.Element, "Result", "")
Dim b As [Byte]() = System.Text.Encoding.Unicode.GetBytes
    ("R0lGODlhCQALAJEAAAoLBv///wAAAP///
    yH5BAEAAAMALAAAAAAJAAsAAAIdlIdmETDAxBAxosm
    CvE9fNU0K40Ae1ZBftq0t9xYAOw==")
imgws.Upload("My Pictures", "1", b, "Red Figure2.gif", True)
MessageBox.Show("Picture uploaded")
Dim a2(0) As String
a2(0) = "Red Figure2.gif"
imgws.Delete("My Pictures", "1", a2)

Web_Reference.Admin adminws = new Web_Reference.Admin();
adminws.Credentials= System.Net.CredentialCache.DefaultCredentials;
try
{
   adminws.CreateSite("http://MyServer/sites/my2003site",
   "My 2003 New Site","Manage content and pictures for year 
      2003",1033,"MPS#0",
   "User_Alias","Display_Name","someone@example.com","","");
}
catch(Exception ex)
{
   MessageBox.Show(ex.Message);
}
Web_Reference.Lists listsws = new Web_Reference.Lists();
listsws.Credentials = System.Net.CredentialCache.DefaultCredentials;
listsws.Url = "http://MyServer/sites/mynewsite/_vti_bin/lists.asmx";
try
{
   listsws.AddList("My Pictures","My personal pictures",109);
}
catch(Exception ex1)
{
   MessageBox.Show(ex1.Message);
}
Web_Reference.Imaging imgws = new Web_Reference.Imaging();
imgws.Credentials = System.Net.CredentialCache.DefaultCredentials;
imgws.Url = "http://MyServer/sites/mynewsite/_vti_bin/imaging.asmx";
    resdoc.CreateNode(System.Xml.XmlNodeType.Element,"Result","");
Byte[] b =System.Text.Encoding.Unicode.GetBytes
    ("R0lGODlhCQALAJEAAAoLBv///wAAAP///
    yH5BAEAAAMALAAAAAAJAAsAAAIdlIdmETDAxBAxosm
    CvE9fNU0K40Ae1ZBftq0t9xYAOw==");
imgws.Upload("My Pictures","1",b,"Red Figure2.gif", true);
MessageBox.Show("Picture uploaded");
String[] a2 = new String[1];
a2[0]="Red Figure2.gif";
imgws.Delete("My Pictures","1",a2);

See Also

Reference

Imaging Class

Imaging Members

Imaging Web Service