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

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.UnsupportedSPType)> _
Public Shared Function SendToOfficialFile ( _
    web As SPWeb, _
    objectUrl As Uri, _
    rgbFile As Byte(), _
    rgofp As RecordsRepositoryProperty(), _
    recordSeries As String, _
    destinationUrl As Uri, _
    submitterEmail As String, _
    submissionMode As SPOfficialFileSubmissionMode, _
    customProcessor As SPFile.CustomFileSubmissionPostProcessing, _
    <OutAttribute> ByRef additionalInformation As String _
) As OfficialFileResult
'Usage
Dim web As SPWeb
Dim objectUrl As Uri
Dim rgbFile As Byte()
Dim rgofp As RecordsRepositoryProperty()
Dim recordSeries As String
Dim destinationUrl As Uri
Dim submitterEmail As String
Dim submissionMode As SPOfficialFileSubmissionMode
Dim customProcessor As SPFile.CustomFileSubmissionPostProcessing
Dim additionalInformation As String
Dim returnValue As OfficialFileResult

returnValue = SPFile.SendToOfficialFile(web, _
    objectUrl, rgbFile, rgofp, recordSeries, _
    destinationUrl, submitterEmail, _
    submissionMode, customProcessor, _
    additionalInformation)

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

See Also

Reference

SPFile Class

SPFile Members

SendToOfficialFile Overload

Microsoft.SharePoint Namespace