ExecuteCellStorageBinaryRequest Method (SPFile, Stream, Boolean, Guid, String, Boolean, String, Boolean, String, String, String, Int64, String, Int64, Boolean, String, Boolean, Int32, String, Boolean, Boolean, Int32)

SPUtility.ExecuteCellStorageBinaryRequest Method (SPFile, Stream, Boolean, Guid, String, Boolean, String, Boolean, String, String, String, Int64, String, Int64, Boolean, String, Boolean, Int32, String, Boolean, Boolean, Int32)

SharePoint 2010

Executes a cell storage request on an SPFile object.

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

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)]
public static Stream ExecuteCellStorageBinaryRequest(
	SPFile spfile,
	Stream request,
	bool coalesce,
	ref Guid partitionID,
	string userName,
	bool coauthVersioning,
	string etagMatching,
	bool fExpectNoFileExists,
	string contentChangeUnit,
	string clientFileID,
	string bypassSchemaID,
	long nLockType,
	string lockID,
	long nTimeout,
	bool createParentFolder,
	out string etagReturn,
	out bool allRequestSucceeded,
	out int coalesceHRESULT,
	out string coalesceErrorMessage,
	out bool containHotboxData,
	out bool haveOnlyDemotionChanges,
	ref int binaryReqCountQuota
)

Parameters

spfile
Type: Microsoft.SharePoint.SPFile

The file that is being read or updated.

request
Type: System.IO.Stream

A binary stream that specifies the details of the update.

coalesce
Type: System.Boolean

Specifies whether all changes to the file are saved to the provider or to an intermediate cache. If true, all changes to the file are saved to the provider; otherwise, the changes are saved to an intermediate cache. For more information, see [MS-FSSHTTP], section 2.3.3.1

partitionID
Type: System.Guid

A unique identifier (ID) for the partition block that contains content or content-specific schema data to be updated. For more information, see [MS-FSSHTTP], section 3.1.1.

userName
Type: System.String

The user name for the client. For more information, see UserNameType in [MS-FSSHTTP], section 2.3.2.6.

coauthVersioning
Type: System.Boolean

Whether versioning of the file is optimized for co-authoring. If true, versioning of the file optimized for co-authoring is enabled; otherwise, versioning of the file is done every time the coalesce process runs. For more information, see [MS-FSSHTTP], section 2.3.3.1.

etagMatching
Type: System.String

A unique value that is updated every time the file contents are changed. The update occurs irrespective of which client updated the file contents of a co-authorable file. For more information, see ETag

fExpectNoFileExists
Type: System.Boolean

Whether to enforce coherency verification during the upload process when etagMatching is null or an empty string. If true, the upload process fails and this method returns a coherency error if the etagMatching parameter is null or an empty string and the file exists; if false and the etagMatching parameter is null or an empty string and a file exists, the file is overwritten.

contentChangeUnit
Type: System.String

A value that uniquely identifies the synchronization version of the file content. For more information, see [MS-FSSHTTP], section 2.3.3.1.

clientFileID
Type: System.String

A value that uniquely identifies the file content. For more information, see [MS-FSSHTTP], section 2.3.3.1.

bypassSchemaID
Type: System.String

The value that the client used to lock the file; the value was sent in a previous upload request. The upload succeeds if this value matches the value of the lock on the file. If this parameter is null or an empty string, this method succeeds only if the file is not locked.

nLockType
Type: System.Int64

The type of lock granted in a co-authoring sub-response or a schema lock subresponse. For more information, see [MS-FSSHTTP], section 2.3.1.7.

lockID
Type: System.String

A value that specifies a unique identifier for an exclusive lock on the file. For more information, see [MS-FSSHTTP], section 2.2.5.8.

nTimeout
Type: System.Int64

The time in seconds that must elapse before the shared lock or exclusive lock associated with the specified file expires. For more information, see [MS-FSSHTTP], section 2.3.1.1.

createParentFolder
Type: System.Boolean

Whether the parent folder for the file needs to be created. If true, the parent folder needs to be created; otherwise it does not need to be created. For more information, see [MS-FSSHTTP], section 2.3.3.1.

etagReturn
Type: System.String

When this method returns, contains the ETag property that was created for the file after any edits have occurred. This parameter is passed uninitialized.

allRequestSucceeded
Type: System.Boolean

When this method returns, contains a value that indicates whether the requests succeeded. This parameter is passed uninitialized.

coalesceHRESULT
Type: System.Int32

When this method returns, contains the error code from the coalesce operation. This parameter is passed uninitialized.

coalesceErrorMessage
Type: System.String

When this method returns, contains any error from the coalesce operation. This parameter is passed uninitialized.

containHotboxData
Type: System.Boolean

When this method returns, contains a value that indicates whether the server store returns some data contained in the hotbox. This parameter is passed uninitialized.

haveOnlyDemotionChanges
Type: System.Boolean

When this method returns, contains whether only changes from SharePoint demotion in the response to the request are contained. If false, this parameter must be ignored. It is passed uninitialized.

binaryReqCountQuota
Type: System.Int32

A value that limits the number of bytes for a binary request that is executed and passed by reference.

Return Value

Type: System.IO.Stream
The return stream.

ExceptionCondition
ArgumentNullException

spfile or request is null .

The lifetime of the return stream is tied to the SPWeb object associated with the SPFile. Therefore, the SPWeb object cannot be disposed while the stream is in use.

Show:
© 2016 Microsoft