SPFile.SendToOfficialFile Method (String, SPOfficialFileHost, String, SPOfficialFileSubmissionMode, String)

Sends file to a specific URL.

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


<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.UnsupportedSPType)> _
Public Function SendToOfficialFile ( _
    recordSeries As String, _
    targetHost As SPOfficialFileHost, _
    submitterEmail As String, _
    submissionMode As SPOfficialFileSubmissionMode, _
    <OutAttribute> ByRef additionalInformation As String _
) As OfficialFileResult
Dim instance As SPFile
Dim recordSeries As String
Dim targetHost As SPOfficialFileHost
Dim submitterEmail As String
Dim submissionMode As SPOfficialFileSubmissionMode
Dim additionalInformation As String
Dim returnValue As OfficialFileResult

returnValue = instance.SendToOfficialFile(recordSeries, _
    targetHost, submitterEmail, submissionMode, _
public OfficialFileResult SendToOfficialFile(
    string recordSeries,
    SPOfficialFileHost targetHost,
    string submitterEmail,
    SPOfficialFileSubmissionMode submissionMode,
    out string additionalInformation


  • submitterEmail
    Type: System.String

    Email address of the submitter when the submission is automated via policy or workflow.

  • 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 submission was successful but there was an error post submission, this string is an XMLstring of the form <info><error>{error message}</error><url>{URL of the final location of the file}</url></info></param>.

    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


SPFile Class

SPFile Members

SendToOfficialFile Overload

Microsoft.SharePoint Namespace