mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='http://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='http://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='http://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='http://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='http://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
MISSING BANNER
Code Details >> Engine_Library >> Endpoints >> ResultsServices >> Get_Search_Results

ResultsServices.Get_Search_Results Method



Performs a search ( or retrieves the search results from the cache ) and outputs the results and search url used


Namespace: SobekCM.Engine_Library.Endpoints
Assembly: SobekCM_Engine_Library (in SobekCM_Engine_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public ResultsServices..::..ResultsEndpointErrorEnum Get_Search_Results(
	Results_Arguments Current_Mode,
	Complete_Item_Aggregation Aggregation_Object,
	Custom_Tracer Tracer,
	out Search_Results_Statistics Complete_Result_Set_Info,
	out List<iSearch_Title_Result> Paged_Results
)

Parameters

Current_Mode
Type: SobekCM.Core.Results..::..Results_Arguments
Mode / navigation information for the current request
Aggregation_Object
Type: SobekCM.Core.Aggregations..::..Complete_Item_Aggregation
Object for the current aggregation object, against which this search is performed
Tracer
Type: SobekCM.Tools..::..Custom_Tracer
Trace object keeps a list of each method executed and important milestones in rendering
Complete_Result_Set_Info
Type: SobekCM.Core.Results..::..Search_Results_Statistics%
[OUT] Information about the entire set of results
Paged_Results
Type: System.Collections.Generic..::..List<(Of <(<'iSearch_Title_Result>)>)>%
[OUT] List of search results for the requested page of results

Return Value

Type: ResultsServices..::..ResultsEndpointErrorEnum

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )