STRUCTURED_QUERY_SINGLE_OPTION Enumerated Type

Provides a set of flags to be used with IQueryParser::SetOption and IQueryParser::GetOption to indicate individual options.

Syntax

typedef enum tagSTRUCTURED_QUERY_SINGLE_OPTION {
    SQSO_SCHEMA = 0,
    SQSO_LOCALE = 1,
    SQSO_WORD_BREAKER = 2,
    SQSO_NATURAL_SYNTAX = 3,
    SQSO_AUTOMATIC_WILDCARD = 4,
    SQSO_TRACE_LEVEL = 5,
    SQSO_LANGUAGE_KEYWORDS = 6
} STRUCTURED_QUERY_SINGLE_OPTION;

Constants

  • SQSO_SCHEMA
    The option value should be a VT_LPWSTR that is the path to a file containing a schema binary. It is set automatically when obtaining a query parser through IQueryParserManager::CreateLoadedParser.

  • SQSO_LOCALE
    The option value must be a VT_UI4 that is a valid LCID. The LCID indicates the expected locale of content words in queries to be parsed and is used to choose a suitable word breaker for the query. IQueryParser::Parse will return an error unless you set either this option or SQSO_WORD_BREAKER before calling it.

  • SQSO_WORD_BREAKER
    When setting this option, the value should be a VT_EMPTY for using the default word breaker for the chosen locale, or a VT_UNKNOWN with an object supporting the IWordBreaker interface. Retrieving the option always returns a VT_UNKNOWN with an object supporting the IWordBreaker interface, unless there is no suitable word breaker for the chosen locale, in which case VT_EMPTY is returned.

  • SQSO_NATURAL_SYNTAX
    The option value should be a VT_EMPTY or a VT_BOOL with VARIANT_TRUE to allow both natural query syntax and advanced query syntax (the default) or a VT_BOOL with VARIANT_FALSE to allow only advanced query syntax. Retrieving the option always returns a VT_BOOL.

  • SQSO_AUTOMATIC_WILDCARD
    The option value should be a VT_BOOL with VARIANT_TRUE to generate query expressions as if each word in the query had the wildcard character * appended to it (unless followed by punctuation other than a parenthesis), a VT_BOOL with VARIANT_FALSE to use the words as they are (the default), or a VT_EMPTY. In most cases, a word-wheeling application should set this option to VARIANT_TRUE. Retrieving the option always returns a VT_BOOL.

  • SQSO_TRACE_LEVEL
    Reserved. The value should be VT_EMPTY (the default) or a VT_I4. Retrieving the option always returns a VT_I4.

  • SQSO_LANGUAGE_KEYWORDS
    The option value must be a VT_I4 that is a valid LANGID. The LANGID indicates the expected language of Structured Query keywords in queries to be parsed. It is set automatically when obtaining a query parser through IQueryParserManager::CreateLoadedParser.

Enumerated Type Information

Header and IDL files structuredquery.h, structuredquery.idl
Minimum operating systems Windows XP Service Pack 2 (SP2) with Windows Desktop Search (WDS) 3.0, Windows Server 2003, Windows Vista