ExecuteSearchWithCount Method
Searches for an entity in the marketing system based on the input parameters. The total number of returned records are available.
Namespace: Microsoft.CommerceServer.Marketing.WebService
Assembly: Microsoft.CommerceServer.Marketing.DataManagement (in Microsoft.CommerceServer.Marketing.DataManagement.dll)
Syntax
'Declaration
<WebMethodAttribute> _
Public Overridable Function ExecuteSearchWithCount ( _
entityType As String, _
searchClause As XmlElement, _
searchOptions As SearchOptions, _
includePerformanceData As Boolean, _
<OutAttribute> ByRef recordsMatched As Integer _
) As DataSet
'Usage
Dim instance As MarketingWebService
Dim entityType As String
Dim searchClause As XmlElement
Dim searchOptions As SearchOptions
Dim includePerformanceData As Boolean
Dim recordsMatched As Integer
Dim returnValue As DataSet
returnValue = instance.ExecuteSearchWithCount(entityType, _
searchClause, searchOptions, includePerformanceData, _
recordsMatched)
[WebMethodAttribute]
public virtual DataSet ExecuteSearchWithCount(
string entityType,
XmlElement searchClause,
SearchOptions searchOptions,
bool includePerformanceData,
out int recordsMatched
)
[WebMethodAttribute]
public:
virtual DataSet^ ExecuteSearchWithCount(
String^ entityType,
XmlElement^ searchClause,
SearchOptions^ searchOptions,
bool includePerformanceData,
[OutAttribute] int% recordsMatched
)
public function ExecuteSearchWithCount(
entityType : String,
searchClause : XmlElement,
searchOptions : SearchOptions,
includePerformanceData : boolean,
recordsMatched : int
) : DataSet
Parameters
- entityType
Type: System..::.String
The type of entity to search.
- searchClause
Type: System.Xml..::.XmlElement
XML that describes how the search should be performed.
- searchOptions
Type: Microsoft.CommerceServer..::.SearchOptions
Object describing how data matching the search clause should be returned.
- includePerformanceData
Type: System..::.Boolean
true to indicate to include performance data should be includes; 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.
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.
Permissions
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.