Search Method (SearchClause, SearchOptions, Boolean, Int32)

  • Article

Executes a unified search for campaign items using the provided search options and performance data option. The total number of returned records are available.

Namespace:  Microsoft.CommerceServer.Marketing
Assembly:  Microsoft.CommerceServer.Marketing.CrossTierTypes (in Microsoft.CommerceServer.Marketing.CrossTierTypes.dll)

Syntax

'Declaration
Public Function Search ( _
    clause As SearchClause, _
    searchOptions As SearchOptions, _
    includePerformanceData As Boolean, _
    <OutAttribute> ByRef recordsMatched As Integer _
) As DataSet

'Usage
Dim instance As CampaignItemManager
Dim clause As SearchClause
Dim searchOptions As SearchOptions
Dim includePerformanceData As Boolean
Dim recordsMatched As Integer
Dim returnValue As DataSet

returnValue = instance.Search(clause, _
    searchOptions, includePerformanceData, _
    recordsMatched)

public DataSet Search(
    SearchClause clause,
    SearchOptions searchOptions,
    bool includePerformanceData,
    out int recordsMatched
)

public:
DataSet^ Search(
    SearchClause^ clause, 
    SearchOptions^ searchOptions, 
    bool includePerformanceData, 
    [OutAttribute] int% recordsMatched
)

public function Search(
    clause : SearchClause, 
    searchOptions : SearchOptions, 
    includePerformanceData : boolean, 
    recordsMatched : int
) : DataSet

Parameters

  • includePerformanceData
    Type: System..::.Boolean
    true to indicate to include performance data; otherwise, false.
  • recordsMatched
    Type: System..::.Int32%
    Returns the total number of records that matched the given query.

Return Value

Type: System.Data..::.DataSet
A DataSet containing the search results.

Exceptions

Exception Condition
ArgumentException

The entity to search is not of CampaignItem type.
ArgumentNullException

No entity type was specified for the search.
EntityDoesNotExistException

Entity type being searched is not in the list of searchable entities.
SearchRecordsPerPageException

The number of records per page requested is greater than the system configured limit.
SearchPageNumberException

Exception is thrown when a requested page (other than the first page) contains no search result records.
SearchException

The clause does not have a valid XML format.

Remarks

The includePerformanceData is a flag to indicate whether to include a DataTable with performance data (event counts) in the resulting DataSet. Performance data is only returned for items in the result set.

The recordsMatched is an out parameter that contains the total number of records that matched the given query.

This method uses the long running SQL command, sqlCommandTimeoutSeconds, of MarketingServices. The long running SQL command time out default is specified in web.config and is normally 120 seconds.

Permissions

See Also

Reference

CampaignItemManager Class

CampaignItemManager Members

Search Overload

Microsoft.CommerceServer.Marketing Namespace