Export (0) Print
Expand All

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

Creates a file in the collection based on the specified URL, on a Stream object that contains a file, a Hashtable object that contains metadata for the file, on SPUser objects that represent the users who created and last modified the file, and on DateTime values that specify when they did so.

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

'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, _
	requireWebFilePermissions 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 requireWebFilePermissions As Boolean
Dim returnValue As SPFile

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

Parameters

urlOfFile
Type: System.String

A String that specifies the URL for the file.

file
Type: System.IO.Stream

A Stream object that contains the file.

properties
Type: System.Collections.Hashtable

A Hashtable object containing metadata for the file.

createdBy
Type: Microsoft.SharePoint.SPUser

A SPUser object that represents the user who created the file.

modifiedBy
Type: Microsoft.SharePoint.SPUser

A SPUser object that represents the user who last modified the file.

timeCreated
Type: System.DateTime

A DateTime value that specifies when the file was created.

timeLastModified
Type: System.DateTime

A DateTime value that specifies when the file was last modified.

checkInComment
Type: System.String

A String containing a check-in comment to use when creating the file in the collection. This method uses migration semantics and will always be created in the checked-in state.

overwrite
Type: System.Boolean

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

requireWebFilePermissions
Type: System.Boolean

true to indicate that adding Web files requires the Add and Customize Web Pages permission; otherwise, false. The default is true.

Return value

Type: Microsoft.SharePoint.SPFile
An SPFile object that represents the file.

This method overwrites any file of the same name only if the overwrite parameter is true.

Show:
© 2014 Microsoft