SPFileCollection.Add method (String, Stream, Hashtable, SPUser, SPUser, DateTime, DateTime, String, Boolean)

Creates a file in the collection using the specified URL, a stream that contains the contents of a file, a hash table that contains metadata for the file, user objects that represent the users who created and last modified the file, DateTime values that specify when they did so, a check-in comment, and a Boolean value that specifies whether to overwrite any file that has the same name.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Function Add ( _
    urlOfFile As String, _
    file As Stream, _
    properties As Hashtable, _
    createdBy As SPUser, _
    modifiedBy As SPUser, _
    timeCreated As DateTime, _
    timeLastModified As DateTime, _
    checkInComment As String, _
    overwrite As Boolean _
) As SPFile
'Usage
Dim instance As SPFileCollection
Dim urlOfFile As String
Dim file As Stream
Dim properties As Hashtable
Dim createdBy As SPUser
Dim modifiedBy As SPUser
Dim timeCreated As DateTime
Dim timeLastModified As DateTime
Dim checkInComment As String
Dim overwrite As Boolean
Dim returnValue As SPFile

returnValue = instance.Add(urlOfFile, _
    file, properties, createdBy, modifiedBy, _
    timeCreated, timeLastModified, checkInComment, _
    overwrite)

public SPFile Add(
    string urlOfFile,
    Stream file,
    Hashtable properties,
    SPUser createdBy,
    SPUser modifiedBy,
    DateTime timeCreated,
    DateTime timeLastModified,
    string checkInComment,
    bool overwrite
)

Parameters

• urlOfFile
  Type: System.String

  The site-relative URL of the file.

• file
  Type: System.IO.Stream

  A stream that contains the file.

• properties
  Type: System.Collections.Hashtable

  A hash table that contains metadata for the file.

• createdBy
  Type: Microsoft.SharePoint.SPUser

  The user who created the file.

• modifiedBy
  Type: Microsoft.SharePoint.SPUser

  The user who last modified the file.

• timeCreated
  Type: System.DateTime

  The date and time when the file was created.

• timeLastModified
  Type: System.DateTime

  The date and time when the file was last modified.

• checkInComment
  Type: System.String

  The text of a comment to use when creating the file in the collection.

• overwrite
  Type: System.Boolean

  true to overwrite a file of the same name; otherwise, false.

Return value

Type: Microsoft.SharePoint.SPFile
The newly added file.

See also

Reference

SPFileCollection class

SPFileCollection members

Add overload

Microsoft.SharePoint namespace