SPFile.SendToOfficialFile Method (String)

Sends the file to a records repository.

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

Syntax

'Declaration
Public Function SendToOfficialFile ( _
    <OutAttribute> ByRef additionalInformation As String _
) As OfficialFileResult
'Usage
Dim instance As SPFile
Dim additionalInformation As String
Dim returnValue As OfficialFileResult

returnValue = instance.SendToOfficialFile(additionalInformation)
public OfficialFileResult SendToOfficialFile(
    out string additionalInformation
)

Parameters

  • additionalInformation
    Type: System.String

    When this method returns, contains a System.String that provides detailed information returned by the Records Center Web service in response to this request. This parameter is passed uninitialized. For more information, see Records Center Web Service Methods.

Return Value

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

Remarks

This method submits a file for archiving in a Records Center. For more information, see Records Center Overview.

If a Records Center Web service is configured for the current Web application, users can right-click a document in a library and choose Send to Records center from the edit control block menu. You can use the SendToOfficialFile method to automate the same operation, perhaps in an event handler or as part of a workflow.

This overload uses the default record routing type. To specify a different record routing type, use SendToOfficialFile(String, String).

If the Web service returns OfficialFileResult.MoreInformation, detailed information is output to the variable named in the argument to the additionalInformation parameter.

See Also

Reference

SPFile Class

SPFile Members

SendToOfficialFile Overload

Microsoft.SharePoint Namespace

OfficialFileResult

Other Resources

Records Center Overview

Records Center Web Service Methods