IRouter.OnSubmitFile Method
NOTE: This API is now obsolete.
Office SharePoint Server 2007 calls this method when a user submits a document with a record series type associated with this custom router to a records repository site.
Namespace: Microsoft.Office.RecordsManagement.RecordsRepository
Assembly: Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)
Syntax
'Declaration
<ObsoleteAttribute("Use Microsoft.Office.RecordsManagement.RecordsRepository.ICustomRouter instead")> _
Function OnSubmitFile ( _
recordSeries As String, _
sourceUrl As String, _
userName As String, _
ByRef fileToSubmit As Byte(), _
ByRef properties As RecordsRepositoryProperty(), _
ByRef destination As SPList, _
ByRef resultDetails As String _
) As RouterResult
'Usage
Dim instance As IRouter
Dim recordSeries As String
Dim sourceUrl As String
Dim userName As String
Dim fileToSubmit As Byte()
Dim properties As RecordsRepositoryProperty()
Dim destination As SPList
Dim resultDetails As String
Dim returnValue As RouterResult
returnValue = instance.OnSubmitFile(recordSeries, _
sourceUrl, userName, fileToSubmit, _
properties, destination, resultDetails)
[ObsoleteAttribute("Use Microsoft.Office.RecordsManagement.RecordsRepository.ICustomRouter instead")]
RouterResult OnSubmitFile(
string recordSeries,
string sourceUrl,
string userName,
ref byte[] fileToSubmit,
ref RecordsRepositoryProperty[] properties,
ref SPList destination,
ref string resultDetails
)
Parameters
recordSeries
Type: System.StringA string that represents the record routing type specified for the submitted document.
sourceUrl
Type: System.StringA string that represents the URL of the document being submitted.
userName
Type: System.StringA string that represents the user login name of the document submitter.
fileToSubmit
Type: []The document being submitted.
properties
Type: []A string that represents the document properties specified by the document submitter.
destination
Type: Microsoft.SharePoint.SPListA string that represents the list in the record repository to which the document is to be submitted, based on the value specified for the recordSeries parameter.
resultDetails
Type: System.StringA string that represents any additional information from the router regarding its processing of the document.
Return Value
Type: Microsoft.Office.RecordsManagement.RecordsRepository.RouterResult
A RouterResult enumeration value specifying the result of the router processing:
SuccessContinueProcessing The router has successfully completed its processing, and the record repository continues with its processing of the document.
SuccessCancelFurtherProcessing The router has successfully completed its processing, but the record repository discontinues its processing of the document. The record repository returns a success value to the calling application, as well as the contents of the resultData parameter.
RejectFile The router did not complete its processing successfully. The record repository returns an error to the calling application, as well as the contents of the resultData parameter.
Remarks
Each custom router must implement the IRouter interface. When a file is submitted to the records repository, Office SharePoint Server 2007 calls the appropriate custom router, if there is one, using the OnSubmitFile method.
The fileToSubmit, properties, destination, and resultData parameters are passed by reference, so that the custom router may change these values as necessary. Therefore, the custom router has the ability to edit the submitted document and its associated metadata, change the storage destination of the document, and communicate details of its processing to the records repository.
See Also
Reference
Microsoft.Office.RecordsManagement.RecordsRepository Namespace
Other Resources
Records Repository Site Template