PurgeJobHistory Method

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The PurgeJobHistory method removes system records maintaining execution history for all Microsoft SQL Server Agent jobs, or those matching the filter criteria specified.

Syntax

object
.PurgeJobHistory( [ Filter ] )

Parts

• object
  Expression that evaluates to an object in the Applies To list.

• Filter
  Optional. A JobHistoryFilter object that constrains record removal to those records identified by the criteria set in the object.

Prototype (C/C++)

HRESULT PurgeJobHistory(
LPSQLDMOJOBHISTORYFILTER pFilter = NULL);

Remarks

For more information about using the JobHistoryFilter object properties to identify job history records, see JobHistoryFilter Object.

Applies To: