Imaging.Upload method

  • Article

Uploads a file to a list on the current Web site.

Namespace:  WebSvcImaging
Assembly:  STSSOAP (in STSSOAP.dll)

Syntax

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

returnValue = instance.Upload(strListName, _
    strFolder, bytes, fileName, fOverWriteIfExist)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/ois/Upload", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/ois/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/ois/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public XmlNode Upload(
    string strListName,
    string strFolder,
    byte[] bytes,
    string fileName,
    bool fOverWriteIfExist
)

Parameters

  • strListName
    Type: System.String

    The name of the list on the current Web site.

  • strFolder
    Type: System.String

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

  • bytes
    Type: []

    The binary content in the file to upload.

  • fileName
    Type: System.String

    The file name to use as item name in the list.

  • fOverWriteIfExist
    Type: System.Boolean

    A Boolean value that indicates whether to overwrite a file with the same name. A FileExists exception is thrown if the item exists and fOverWriteIfExist is not true.

Return value

Type: System.Xml.XmlNode
A Microsoft.SharePoint.SoapServer.SoapXml object that returns the last modified date of the item if the operation succeeds.

<results xmlns="https://schemas.microsoft.com/sharepoint/soap/ois/" 
  lastmodified="..."/>

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 code example uploads an image named "Red Figure2.gif" to the "1" folder in the "My Pictures" library on http://MyServer/sites/mynewsite. The code assumes that the site and the picture library already exist, that you have permissions on the server, and that the picture library contains some items. 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 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)

Web_Reference.Imaging imgws = new Web_Reference.Imaging();
imgws.Credentials = System.Net.CredentialCache.DefaultCredentials;
imgws.Url = "http://MyServer/sites/mynewsite/_vti_bin/imaging.asmx";
System.Xml.XmlDocument resdoc= new System.Xml.XmlDocument();
System.Xml.XmlNode resnode = 
   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);

The following code example shows how to create the site and the picture library required in the earlier example.

Note

You must be a member of the Administrators 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", 
            "DOMAIN\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)

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",
      "DOMAIN\\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";
System.Xml.XmlDocument resdoc= new System.Xml.XmlDocument();
System.Xml.XmlNode resnode = 
   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);

See also

Reference

Imaging class

Imaging members

WebSvcImaging namespace