Perform a search.


Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)

Syntax

Visual Basic (Declaration)
Public Function search( _ 
   ByVal tblCfgs As NetricsSearchCfg(),  _ 
   ByVal opts As NetricsSearchOpts _ 
) As NetricsSearchResponse _
    Implements INetricsServerInterface.search
C#
public NetricsSearchResponse search(
   NetricsSearchCfg[] tblCfgs,
   NetricsSearchOpts opts
)
C++
public:
 NetricsSearchResponse search(
   array<NetricsSearchCfg>^ tblCfgs,
   NetricsSearchOpts opts
) sealed 
J#
public NetricsSearchResponse search(
   NetricsSearchCfg[] tblCfgs,
   NetricsSearchOpts opts
)
JScript
public  function search(
   tblCfgs : NetricsSearchCfg[],
   opts : NetricsSearchOpts
) : NetricsSearchResponse

Parameters

tblCfgs
One NetricsSearchCfg per table which will be searched (can be specified in any order)
opts
The configuration object for the overall search - allows a number of options for searching

Return Value

A NetricsSearchResponse object containing the results of the search

Implements

INetricsServerInterface.search

Exceptions

Exception TypeCondition
NetricsExceptionIf the server indicates that an error has occured (Possible errors - ARRAYLEN, TBLLOCKED, TBLNOTFOUND, EXPECTTBLDESC, EXPECTRTBLDESC, EXPECTLIST, EXPECTQUERY, FEATUREOFF, FEATURESET, LISTLEN, LOOKUP, NOTBLDESC, NOQUERY, NSFIELD, NUMFIELDS, PARAMCONFLICT, PARAMMISSING, PARAMVAL, PARTIAL, PREDTYPE, SRCHPARAM, THESNOTFOUND, UNKFIELD)

Remarks

Queries are set in the NetricsSearchCfg objects and overall search options are set in the NetricsSearchOpts object

See Also

Syntax based on .NET Framework version 2.0.
Documentation version 1.0.0.0.