SPFile.SendToOfficialFile method (String, SPOfficialFileHost, String, SPOfficialFileSubmissionMode, String)
Sends file to a specific URL.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
Public Function SendToOfficialFile ( _
recordSeries As String, _
targetHost As SPOfficialFileHost, _
submitterEmail As String, _
submissionMode As SPOfficialFileSubmissionMode, _
<OutAttribute> ByRef additionalInformation As String _
) As OfficialFileResult
'Usage
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, _
additionalInformation)
public OfficialFileResult SendToOfficialFile(
string recordSeries,
SPOfficialFileHost targetHost,
string submitterEmail,
SPOfficialFileSubmissionMode submissionMode,
out string additionalInformation
)
Parameters
recordSeries
Type: System.StringContent type of the file.
targetHost
Type: Microsoft.SharePoint.SPOfficialFileHostThe host object that contains destination URL and whether this is a move, copy, or move and link operation.
submitterEmail
Type: System.StringEmail address of the submitter when the submission is automated via policy or workflow.
submissionMode
Type: Microsoft.SharePoint.SPOfficialFileSubmissionModeSpecifies how the file was submitted. Possible values are Manual, Policy, Workflow, and other.
additionalInformation
Type: System.StringWhen 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.