IDSSIndexSearch Interface Reference

List of all members.

---

Detailed Description

this interface contains all the options the searcher needs.

Actually, it should be better called IDSSSearchOptions or IDSSSearchParams.

Public Member Functions
HRESULT	BeginCreateTime ([out, retval] DATE *opTime)
HRESULT	BeginCreateTime ([in] DATE iTime)
	[optional], default : 0, which means invalid
HRESULT	BeginModifyTime ([out, retval] DATE *opTime)
HRESULT	BeginModifyTime ([in] DATE iTime)
	[optional], default : 0, which means invalid
HRESULT	Count ([out, retval] Int32 *opCount)
HRESULT	Count ([in] Int32 iCount)
	[optional], default : -1, which means return all the documents Specify the number of the documents should be returned.
HRESULT	DocFields ([out, retval] BSTR *opDocFields)
HRESULT	DocFields ([in] BSTR iDocFields)
	only retrieve document fields specified in docFields, fields are separated by ",", if docFields is null or empty, retrieve all fields
HRESULT	EndCreateTime ([out, retval] DATE *opTime)
HRESULT	EndCreateTime ([in] DATE iTime)
	[optional], default : -1, which means invalid
HRESULT	EndModifyTime ([out, retval] DATE *opTime)
HRESULT	EndModifyTime ([in] DATE iTime)
	[optional], default : -1, which means invalid
HRESULT	FacetParameter ([out, retval] IDSSFacetParameter opFacetParameter)
HRESULT	FacetParameter ([in] IDSSFacetParameter *ipFacetParameter)
	[optional], default : null, which means collect nothing
HRESULT	IncludeManagedObject ([out, retval] VARIANT_BOOL *opFlag)
HRESULT	IncludeManagedObject ([in] VARIANT_BOOL iFlag)
	[optional], default : -1, which means invalid
HRESULT	Locale ([out, retval] Int32 *opLocale)
HRESULT	Locale ([in] Int32 iLocale)
	[optional], default : 0, which means user's effective locale
HRESULT	Owners ([out, retval] IDSSVariantCollection opOwnerIDs)
	[optional], default : empty, which means do not filter the result by owner.
HRESULT	Projects ([out, retval] IDSSVariantCollection opProjectIDs)
	[optional], default : empty, which means do not filter the result by project.
HRESULT	Query ([out, retval] BSTR *opQuery)
HRESULT	Query ([in] BSTR iQuery)
	[must] The query you want to search
HRESULT	Recursive ([out, retval] VARIANT_BOOL *opFlag)
HRESULT	Recursive ([in] VARIANT_BOOL iFlag)
	[optional], default : true, which means search include subfolders
HRESULT	SearchDomainFlag ([out, retval] EnumDSSIndexSearchDomainFlag *oSearchDomainFlag)
HRESULT	SearchDomainFlag ([in] EnumDSSIndexSearchDomainFlag iSearchDomainFlag)
	[optional, default : DssIndexSearchDomainMD
HRESULT	SearchRootFolders ([out, retval] IDSSVariantCollection opFolderIDs)
	[optional], default : empty, which means do not filter the result by folders.
HRESULT	SearchType ([out, retval] EnumSESearchType *opSearchType)
HRESULT	SearchType ([in] EnumSESearchType iSearchType)
	[optional], default : 0, which means simple search.
HRESULT	Start ([out, retval] Int32 *opStart)
HRESULT	Start ([in] Int32 iStart)
	[optional], default : 0, the start index
HRESULT	Types ([out, retval] IDSSVariantCollection opTypes)
	[optional], default : empty, which means do not filter the result by types.

---

Member Function Documentation

HRESULT IDSSIndexSearch::BeginCreateTime (  [out, retval] DATE *  opTime  )

HRESULT IDSSIndexSearch::BeginCreateTime (  [in] DATE  iTime  )

[optional], default : 0, which means invalid

HRESULT IDSSIndexSearch::BeginModifyTime (  [out, retval] DATE *  opTime  )

HRESULT IDSSIndexSearch::BeginModifyTime (  [in] DATE  iTime  )

[optional], default : 0, which means invalid

HRESULT IDSSIndexSearch::Count (  [out, retval] Int32 *  opCount  )

HRESULT IDSSIndexSearch::Count (  [in] Int32  iCount  )

[optional], default : -1, which means return all the documents Specify the number of the documents should be returned. if the value is 0, then use the page size In SearchUserProperties instead, if the value is less than 0, means return all the documents

HRESULT IDSSIndexSearch::DocFields (  [out, retval] BSTR *  opDocFields  )

HRESULT IDSSIndexSearch::DocFields (  [in] BSTR  iDocFields  )

only retrieve document fields specified in docFields, fields are separated by ",", if docFields is null or empty, retrieve all fields

HRESULT IDSSIndexSearch::EndCreateTime (  [out, retval] DATE *  opTime  )

HRESULT IDSSIndexSearch::EndCreateTime (  [in] DATE  iTime  )

[optional], default : -1, which means invalid

HRESULT IDSSIndexSearch::EndModifyTime (  [out, retval] DATE *  opTime  )

HRESULT IDSSIndexSearch::EndModifyTime (  [in] DATE  iTime  )

[optional], default : -1, which means invalid

HRESULT IDSSIndexSearch::FacetParameter (  [out, retval] IDSSFacetParameter   opFacetParameter  )

HRESULT IDSSIndexSearch::FacetParameter (  [in] IDSSFacetParameter *  ipFacetParameter  )

[optional], default : null, which means collect nothing

HRESULT IDSSIndexSearch::IncludeManagedObject (  [out, retval] VARIANT_BOOL *  opFlag  )

HRESULT IDSSIndexSearch::IncludeManagedObject (  [in] VARIANT_BOOL  iFlag  )

[optional], default : -1, which means invalid

HRESULT IDSSIndexSearch::Locale (  [out, retval] Int32 *  opLocale  )

HRESULT IDSSIndexSearch::Locale (  [in] Int32  iLocale  )

[optional], default : 0, which means user's effective locale

HRESULT IDSSIndexSearch::Owners (  [out, retval] IDSSVariantCollection   opOwnerIDs  )

[optional], default : empty, which means do not filter the result by owner. you can add multiple owners' id(BSTR) into the opOwnerIDs

HRESULT IDSSIndexSearch::Projects (  [out, retval] IDSSVariantCollection   opProjectIDs  )

[optional], default : empty, which means do not filter the result by project. you can add multiple projects' id(BSTR) Into the opProjectIDs

HRESULT IDSSIndexSearch::Query (  [out, retval] BSTR *  opQuery  )

HRESULT IDSSIndexSearch::Query (  [in] BSTR  iQuery  )

[must] The query you want to search

HRESULT IDSSIndexSearch::Recursive (  [out, retval] VARIANT_BOOL *  opFlag  )

HRESULT IDSSIndexSearch::Recursive (  [in] VARIANT_BOOL  iFlag  )

[optional], default : true, which means search include subfolders

HRESULT IDSSIndexSearch::SearchDomainFlag (  [out, retval] EnumDSSIndexSearchDomainFlag *  oSearchDomainFlag  )

HRESULT IDSSIndexSearch::SearchDomainFlag (  [in] EnumDSSIndexSearchDomainFlag  iSearchDomainFlag  )

[optional, default : DssIndexSearchDomainMD

HRESULT IDSSIndexSearch::SearchRootFolders (  [out, retval] IDSSVariantCollection   opFolderIDs  )

[optional], default : empty, which means do not filter the result by folders. you can add multiple pair of (folder's project id(BSTR), folder's object id(BSTR)) Into the opFolderIDs

HRESULT IDSSIndexSearch::SearchType (  [out, retval] EnumSESearchType *  opSearchType  )

HRESULT IDSSIndexSearch::SearchType (  [in] EnumSESearchType  iSearchType  )

[optional], default : 0, which means simple search. 1 means relationship search

HRESULT IDSSIndexSearch::Start (  [out, retval] Int32 *  opStart  )

HRESULT IDSSIndexSearch::Start (  [in] Int32  iStart  )

[optional], default : 0, the start index

HRESULT IDSSIndexSearch::Types (  [out, retval] IDSSVariantCollection   opTypes  )

[optional], default : empty, which means do not filter the result by types. you can add multiple types(int) Into the opTypes

---