Table of Contents

Class ShellProperties.PropertySystemSearch

Namespace
Microsoft.WindowsAPICodePack.Shell.PropertySystem
Assembly
Microsoft.WindowsAPICodePack.Shell.dll

System.Search Properties

public class ShellProperties.PropertySystemSearch : PropertyStoreItems
Inheritance
ShellProperties.PropertySystemSearch
Inherited Members

Properties

AutoSummary

Name: System.Search.AutoSummary -- PKEY_Search_AutoSummary

Description: General Summary of the document.

Type: String -- VT_LPWSTR (For variants: VT_BSTR)

FormatID: {560C36C0-503A-11CF-BAA1-00004C752A9A}, 2

public ShellProperty<string> AutoSummary { get; }

Property Value

ShellProperty<string>

ContainerHash

Name: System.Search.ContainerHash -- PKEY_Search_ContainerHash

Description: Hash code used to identify attachments to be deleted based on a common container url

Type: String -- VT_LPWSTR (For variants: VT_BSTR)

FormatID: {BCEEE283-35DF-4D53-826A-F36A3EEFC6BE}, 100

public ShellProperty<string> ContainerHash { get; }

Property Value

ShellProperty<string>

Contents

Name: System.Search.Contents -- PKEY_Search_Contents

Description: The contents of the item. This property is for query restrictions only; it cannot be retrieved in a query result. The Indexing Service friendly name is 'contents'.

Type: String -- VT_LPWSTR (For variants: VT_BSTR)

FormatID: (FMTID_Storage) {B725F130-47EF-101A-A5F1-02608C9EEBAC}, 19 (PID_STG_CONTENTS)

public ShellProperty<string> Contents { get; }

Property Value

ShellProperty<string>

EntryID

Name: System.Search.EntryID -- PKEY_Search_EntryID

Description: The entry ID for an item within a given catalog in the Windows Search Index. This value may be recycled, and therefore is not considered unique over time.

Type: Int32 -- VT_I4

FormatID: (FMTID_Query) {49691C90-7E17-101A-A91C-08002B2ECDA9}, 5 (PROPID_QUERY_WORKID)

public ShellProperty<int?> EntryID { get; }

Property Value

ShellProperty<int?>

ExtendedProperties

Name: System.Search.ExtendedProperties -- PKEY_Search_ExtendedProperties

Description:

Type: Blob -- VT_BLOB

FormatID: {7B03B546-FA4F-4A52-A2FE-03D5311E5865}, 100

public ShellProperty<byte[]> ExtendedProperties { get; }

Property Value

ShellProperty<byte[]>

GatherTime

Name: System.Search.GatherTime -- PKEY_Search_GatherTime

Description: The Datetime that the Windows Search Gatherer process last pushed properties of this document to the Windows Search Gatherer Plugins.

Type: DateTime -- VT_FILETIME (For variants: VT_DATE)

FormatID: {0B63E350-9CCC-11D0-BCDB-00805FCCCE04}, 8

public ShellProperty<DateTime?> GatherTime { get; }

Property Value

ShellProperty<DateTime?>

HitCount

Name: System.Search.HitCount -- PKEY_Search_HitCount

Description: When using CONTAINS over the Windows Search Index, this is the number of matches of the term. If there are multiple CONTAINS, an AND computes the min number of hits and an OR the max number of hits.

Type: Int32 -- VT_I4

FormatID: (FMTID_Query) {49691C90-7E17-101A-A91C-08002B2ECDA9}, 4 (PROPID_QUERY_HITCOUNT)

public ShellProperty<int?> HitCount { get; }

Property Value

ShellProperty<int?>

IsClosedDirectory

Name: System.Search.IsClosedDirectory -- PKEY_Search_IsClosedDirectory

Description: If this property is emitted with a value of TRUE, then it indicates that this URL's last modified time applies to all of it's children, and if this URL is deleted then all of it's children are deleted as well. For example, this would be emitted as TRUE when emitting the URL of an email so that all attachments are tied to the last modified time of that email.

Type: Boolean -- VT_BOOL

FormatID: {0B63E343-9CCC-11D0-BCDB-00805FCCCE04}, 23

public ShellProperty<bool?> IsClosedDirectory { get; }

Property Value

ShellProperty<bool?>

IsFullyContained

Name: System.Search.IsFullyContained -- PKEY_Search_IsFullyContained

Description: Any child URL of a URL which has System.Search.IsClosedDirectory=TRUE must emit System.Search.IsFullyContained=TRUE. This ensures that the URL is not deleted at the end of a crawl because it hasn't been visited (which is the normal mechanism for detecting deletes). For example an email attachment would emit this property

Type: Boolean -- VT_BOOL

FormatID: {0B63E343-9CCC-11D0-BCDB-00805FCCCE04}, 24

public ShellProperty<bool?> IsFullyContained { get; }

Property Value

ShellProperty<bool?>

QueryFocusedSummary

Name: System.Search.QueryFocusedSummary -- PKEY_Search_QueryFocusedSummary

Description: Query Focused Summary of the document.

Type: String -- VT_LPWSTR (For variants: VT_BSTR)

FormatID: {560C36C0-503A-11CF-BAA1-00004C752A9A}, 3

public ShellProperty<string> QueryFocusedSummary { get; }

Property Value

ShellProperty<string>

QueryFocusedSummaryWithFallback

Name: System.Search.QueryFocusedSummaryWithFallback -- PKEY_Search_QueryFocusedSummaryWithFallback

Description: Query Focused Summary of the document, if none is available it returns the AutoSummary.

Type: String -- VT_LPWSTR (For variants: VT_BSTR)

FormatID: {560C36C0-503A-11CF-BAA1-00004C752A9A}, 4

public ShellProperty<string> QueryFocusedSummaryWithFallback { get; }

Property Value

ShellProperty<string>

Rank

Name: System.Search.Rank -- PKEY_Search_Rank

Description: Relevance rank of row. Ranges from 0-1000. Larger numbers = better matches. Query-time only.

Type: Int32 -- VT_I4

FormatID: (FMTID_Query) {49691C90-7E17-101A-A91C-08002B2ECDA9}, 3 (PROPID_QUERY_RANK)

public ShellProperty<int?> Rank { get; }

Property Value

ShellProperty<int?>

Store

Name: System.Search.Store -- PKEY_Search_Store

Description: The identifier for the protocol handler that produced this item. (E.g. MAPI, CSC, FILE etc.)

Type: String -- VT_LPWSTR (For variants: VT_BSTR)

FormatID: {A06992B3-8CAF-4ED7-A547-B259E32AC9FC}, 100

public ShellProperty<string> Store { get; }

Property Value

ShellProperty<string>

UrlToIndex

Name: System.Search.UrlToIndex -- PKEY_Search_UrlToIndex

Description: This property should be emitted by a container IFilter for each child URL within the container. The children will eventually be crawled by the indexer if they are within scope.

Type: String -- VT_LPWSTR (For variants: VT_BSTR)

FormatID: {0B63E343-9CCC-11D0-BCDB-00805FCCCE04}, 2

public ShellProperty<string> UrlToIndex { get; }

Property Value

ShellProperty<string>

UrlToIndexWithModificationTime

Name: System.Search.UrlToIndexWithModificationTime -- PKEY_Search_UrlToIndexWithModificationTime

Description: This property is the same as System.Search.UrlToIndex except that it includes the time the URL was last modified. This is an optimization for the indexer as it doesn't have to call back into the protocol handler to ask for this information to determine if the content needs to be indexed again. The property is a vector with two elements, a VT_LPWSTR with the URL and a VT_FILETIME for the last modified time.

Type: Multivalue Any -- VT_VECTOR | VT_NULL (For variants: VT_ARRAY | VT_NULL)

FormatID: {0B63E343-9CCC-11D0-BCDB-00805FCCCE04}, 12

public ShellProperty<object> UrlToIndexWithModificationTime { get; }

Property Value

ShellProperty<object>