ExecuteSearch Method

2009-11-12

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Searches for an entity in the profiles system based on the input parameters.

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

Syntax

'Declaration
Public Function ExecuteSearch ( _
    entityName As String, _
    searchClause As SearchClause, _
    searchOptions As SearchOptions _
) As DataSet

'Usage
Dim instance As ProfileManagementContext
Dim entityName As String
Dim searchClause As SearchClause
Dim searchOptions As SearchOptions
Dim returnValue As DataSet

returnValue = instance.ExecuteSearch(entityName, _
    searchClause, searchOptions)

public DataSet ExecuteSearch(
    string entityName,
    SearchClause searchClause,
    SearchOptions searchOptions
)

public:
DataSet^ ExecuteSearch(
    String^ entityName, 
    SearchClause^ searchClause, 
    SearchOptions^ searchOptions
)

public function ExecuteSearch(
    entityName : String, 
    searchClause : SearchClause, 
    searchOptions : SearchOptions
) : DataSet

Parameters

entityName
Type: System..::.String
Name of the profile definition that will be the target of the search.

searchClause
Type: Microsoft.CommerceServer..::.SearchClause
A SearchClause object that describes the search criteria.

searchOptions
Type: Microsoft.CommerceServer..::.SearchOptions
A SearchOptions object describing how data matching the search clause should be returned.

Return Value

Type: System.Data..::.DataSet
A DataSet containing the profile instances that matched the searchClause provided.

Exceptions

Exception	Condition
ArgumentNullException	Either of entityName or searchOptions parameters is nullNothingnullptra null reference (Nothing in Visual Basic).
ArgumentException	The key value provided is not the correct type.
AuthenticationException	User has not been authenticated.
NotAuthorizedException	User is not authorized to perform this task.
DefinitionDoesNotExistException	The searchClause indicates a profile that does not exist.
PropertyDoesNotExistException	The search is being executed against a profile property that does not exist.

Remarks

Executes a search on the server.

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.

Share via