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

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 check-in comment, and a Boolean value that specifies whether to check required fields.

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

Syntax

'Declaration
Public Function Add ( _
    urlOfFile As String, _
    file As Stream, _
    overwrite As Boolean, _
    checkInComment As String, _
    checkRequiredFields As Boolean _
) As SPFile
'Usage
Dim instance As SPFileCollection
Dim urlOfFile As String
Dim file As Stream
Dim overwrite As Boolean
Dim checkInComment As String
Dim checkRequiredFields As Boolean
Dim returnValue As SPFile

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

Parameters

  • 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.

  • checkInComment
    Type: System.String

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

  • checkRequiredFields
    Type: System.Boolean

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

Return value

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

See also

Reference

SPFileCollection class

SPFileCollection members

Add overload

Microsoft.SharePoint namespace