IProcess.ProcessItem Method

Performs custom processing on the specified item.

Namespace:  Microsoft.Office.RecordsManagement.SearchAndProcess
Assembly:  Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)

Syntax

'Declaration
Function ProcessItem ( _
    item As SPListItem, _
    rgstrOtherArgs As String(), _
    <OutAttribute> ByRef strMessage As String _
) As Boolean

'Usage
Dim instance As IProcess
Dim item As SPListItem
Dim rgstrOtherArgs As String()
Dim strMessage As String
Dim returnValue As Boolean

returnValue = instance.ProcessItem(item, _
    rgstrOtherArgs, strMessage)

bool ProcessItem(
    SPListItem item,
    string[] rgstrOtherArgs,
    out string strMessage
)

Parameters

• item
  Type: Microsoft.SharePoint.SPListItem
  The item to be processed.

• rgstrOtherArgs
  Type: []
  Any optional arguments the user specified for Office SharePoint Server 2007 to pass to the assembly.

• strMessage
  Type: System.String
  An output parameter for the assembly to return detailed processing information to Office SharePoint Server 2007.

Return Value

Type: System.Boolean
A Boolean that specifies whether the item was successfully processed.

Remarks

During a search and process operation, Office SharePoint Server 2007 calls the ProcessItem method once for each item in the search return set.

Office SharePoint Server 2007 stores the Boolean success indicator, as well as any detailed information returned from the strMessage parameter, for each item processed. Office SharePoint Server 2007 includes this information in the search and process job summary report that is sent in e-mail to the specified users.

For more information about how Office SharePoint Server 2007 invokes the IProcess interface during search and process operations, see Search and Process Development Process.

See Also

Reference

IProcess Interface

IProcess Members

Microsoft.Office.RecordsManagement.SearchAndProcess Namespace