IRouter.OnSubmitFile, méthode (Microsoft.Office.RecordsManagement.RecordsRepository)

Article
02/01/2010

Called when a user submits a document with a record series type that is associated with this custom router to a records repository site.

Espace de noms : Microsoft.Office.RecordsManagement.RecordsRepository
Assembly : Microsoft.Office.Policy (dans microsoft.office.policy.dll)

Syntaxe

'Déclaration
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
'Utilisation
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)

RouterResult OnSubmitFile (
    string recordSeries,
    string sourceUrl,
    string userName,
    ref byte[] fileToSubmit,
    ref RecordsRepositoryProperty[] properties,
    ref SPList destination,
    ref string resultDetails
)

Paramètres

recordSeries
A string that represents the record routing type specified for the submitted document.

sourceUrl
A string that represents the URL of the document being submitted.

userName
A string that represents the user logon name of the document submitter.

fileToSubmit
The document being submitted.

properties
A string that represents the document properties specified by the document submitter.

destination
A 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
A string that represents additional information from the router regarding its processing of the document.

Valeur de retour

A RouterResult enumeration value specifying the result of the router processing, as follows:

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

Remarques

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, by using the OnSubmitFile method.

The fileToSubmit, properties, destination, and resultData parameters are passed by reference, so that the custom router can 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.

Voir aussi

Référence

IRouter, interface
Membres IRouter
Microsoft.Office.RecordsManagement.RecordsRepository, espace de noms

Autres ressources

Centre d'enregistrements
Modèle de site Centre des enregistrements
Traitement des fichiers du Centre d'enregistrements
Routeur personnalisé du Centre d'enregistrements

Partager via