Submits the specified query string to the e-FAQ server.
Namespace: ININ.IceLib.EFaqAssembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public EFaqQueryResults Query( string queryString, IEnumerable<EFaqTopic> faqs, EFaqQueryOptions options ) |
Visual Basic |
---|
Public Function Query ( _ queryString As String, _ faqs As IEnumerable(Of EFaqTopic), _ options As EFaqQueryOptions _ ) As EFaqQueryResults |
Parameters
- queryString
- Type: System..::..String
The query string.
- faqs
- Type: System.Collections.Generic..::..IEnumerable<(Of <(<'EFaqTopic>)>)>
The faqs on the server that are to be included in the search.
- options
- Type: ININ.IceLib.EFaq..::..EFaqQueryOptions
The query options.
Return Value
An EFaqQueryResults object representing the result set returned by the e-FAQ server.Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 SU 2 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 SU 2 and beyond.