SPFile.SendToOfficialFile Method (SPWeb, Uri, Byte[], RecordsRepositoryProperty[], String, Uri, String, SPOfficialFileSubmissionMode, SPFile.CustomFileSubmissionPostProcessing, String)

Sends file to a destination router.

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

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.UnsupportedSPType)]
public static OfficialFileResult SendToOfficialFile(
	SPWeb web,
	Uri objectUrl,
	byte[] rgbFile,
	RecordsRepositoryProperty[] rgofp,
	string recordSeries,
	Uri destinationUrl,
	string submitterEmail,
	SPOfficialFileSubmissionMode submissionMode,
	SPFile.CustomFileSubmissionPostProcessing customProcessor,
	out string additionalInformation
)

Parameters

web
Type: Microsoft.SharePoint.SPWeb

Web that contains the source object being sent.

objectUrl
Type: System.Uri

Url of the object being sent.

rgbFile
Type: []

Content of the file created at the target.

rgofp
Type: []

Properties for the file created at the target.

recordSeries
Type: System.String

Content type of the file created at the target.

destinationUrl
Type: System.Uri

URL to the destination router

submitterEmail
Type: System.String

Email address of the submitter

submissionMode
Type: Microsoft.SharePoint.SPOfficialFileSubmissionMode

Mode of submission. Possible values are Manual, Policy, Workflow, and other.

customProcessor
Type: Microsoft.SharePoint.SPFile.CustomFileSubmissionPostProcessing

Action performed upon successful completion of submission when file has been created at target.

additionalInformation
Type: System.String

When this method returns, contains a System.String that provides extra information from the operation. This parameter is passed uninitialized.

If submission was successful, this string is an XML string of the form <info><url>{Url of the final location of the file}</url></info>

If the submission requires more information, the string contains the URL where more information can be given to route the file at destination.

If the submission was rejected, the string contains information about why it was rejected.

Return Value

Type: Microsoft.SharePoint.OfficialFileResult
An OfficialFileResult enumeration value.
Show: