Export (0) Print
Expand All

SPFile.SendToOfficialFile Method (String, SPOfficialFileHost, RecordsRepositoryProperty[], 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 OfficialFileResult SendToOfficialFile(
	string recordSeries,
	SPOfficialFileHost targetHost,
	RecordsRepositoryProperty[] rgofp,
	string submitterEmail,
	SPOfficialFileSubmissionMode submissionMode,
	out string additionalInformation
)

Parameters

recordSeries
Type: System.String
Content type of the file.
targetHost
Type: Microsoft.SharePoint.SPOfficialFileHost
The host object that contains destination URL and whether this is a move, copy, or move and link operation.
rgofp
Type: []
File properties and custom properties that should be sent for this file. Can be a null reference (Nothing in Visual Basic). If a null reference (Nothing in Visual Basic), the default properties for submission from the file's properties will be used.
submitterEmail
Type: System.String
Email address of the submitter when the submission is automated via policy or workflow.
submissionMode
Type: Microsoft.SharePoint.SPOfficialFileSubmissionMode
Specifies how the file was submitted. Possible values are Manual, Policy, Workflow, and other.
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 XML string 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 regarding why it was rejected.

Return Value

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

Community Additions

ADD
Show:
© 2014 Microsoft