DocumentSet.SendToOfficialFile method

Sends the DocumentSet object to a records repository.

Namespace:  Microsoft.Office.DocumentManagement.DocumentSets
Assembly:  Microsoft.Office.DocumentManagement (in Microsoft.Office.DocumentManagement.dll)

Syntax

'Declaration
Public Function SendToOfficialFile ( _
    strRecordSeries As String, _
    <OutAttribute> ByRef strAdditionalInfo As String, _
    targetHost As SPOfficialFileHost, _
    submitter As String, _
    submissionMode As SPOfficialFileSubmissionMode _
) As OfficialFileResult
'Usage
Dim instance As DocumentSet
Dim strRecordSeries As String
Dim strAdditionalInfo As String
Dim targetHost As SPOfficialFileHost
Dim submitter As String
Dim submissionMode As SPOfficialFileSubmissionMode
Dim returnValue As OfficialFileResult

returnValue = instance.SendToOfficialFile(strRecordSeries, _
    strAdditionalInfo, targetHost, submitter, _
    submissionMode)

public OfficialFileResult SendToOfficialFile(
    string strRecordSeries,
    out string strAdditionalInfo,
    SPOfficialFileHost targetHost,
    string submitter,
    SPOfficialFileSubmissionMode submissionMode
)

Parameters

• strRecordSeries
  Type: System.String

  The content type of the file created at the target

• strAdditionalInfo
  Type: System.String

  A reference to a string where supplemental information from the operation will be placed.

• targetHost
  Type: Microsoft.SharePoint.SPOfficialFileHost

  An object that represents the external connection to a record center to receive the files.

• submitter
  Type: System.String

  The e-mail address of the submitter.

• submissionMode
  Type: Microsoft.SharePoint.SPOfficialFileSubmissionMode

  One of the enumeration values that specifies the mode that was used to submit the DocumentSet file.

Return value

Type: Microsoft.SharePoint.OfficialFileResult
A OfficialFileResult object.

Remarks

strAdditionalInfo <info><url>{Url of the final location of the file}</url></info>

See also

Reference

DocumentSet class

DocumentSet members

Microsoft.Office.DocumentManagement.DocumentSets namespace