SPFileCollection.Add Method (String, Stream, Boolean, Boolean, Stream, String)

Creates a file in the collection using the specified URL, a stream that contains the contents of a file, a Boolean value that specifies whether to overwrite any file that has the same name, a Boolean value that specifies whether to check required fields, a stream that contains file format metadata, and an output variable to receive an ETag.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Available in SharePoint Online


<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.MarshalByRefObject)> _
Public Function Add ( _
    urlOfFile As String, _
    file As Stream, _
    overwrite As Boolean, _
    checkRequiredFields As Boolean, _
    fileFormatMetaInfo As Stream, _
    <OutAttribute> ByRef etagNew As String _
) As SPFile
Dim instance As SPFileCollection
Dim urlOfFile As String
Dim file As Stream
Dim overwrite As Boolean
Dim checkRequiredFields As Boolean
Dim fileFormatMetaInfo As Stream
Dim etagNew As String
Dim returnValue As SPFile

returnValue = instance.Add(urlOfFile, _
    file, overwrite, checkRequiredFields, _
    fileFormatMetaInfo, etagNew)
public SPFile Add(
    string urlOfFile,
    Stream file,
    bool overwrite,
    bool checkRequiredFields,
    Stream fileFormatMetaInfo,
    out string etagNew


  • urlOfFile
    Type: System.String

    The site-relative URL of the file.

  • overwrite
    Type: System.Boolean

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

  • checkRequiredFields
    Type: System.Boolean

    true to check for required fields when saving the file; otherwise, false.

  • fileFormatMetaInfo
    Type: System.IO.Stream

    A stream that contains the file format metadata for the new file.

  • etagNew
    Type: System.String

    A reference to an ETag object that will contain a unique identifier for this version of the file.

Return Value

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

See Also


SPFileCollection Class

SPFileCollection Members

Add Overload

Microsoft.SharePoint Namespace