sean-m
/
Vanara
mirror of https://github.com/dahall/Vanara.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Added Windows Search assembly

pull/60/head
David Hall 2019-05-25 19:46:56 -06:00
parent 0771f6b30d
commit 6e81310eb6
6 changed files with 9837 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
PInvoke/SearchApi/CorrelationReport.md Normal file
View File

@ -0,0 +1,62 @@
## Correlation report for
### Structures
Native Structure | Header | Managed Structure
--- | --- | ---
[AUTHENTICATION_INFO](https://www.google.com/search?num=5&q=AUTHENTICATION_INFO+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+AUTHENTICATION_INFO
[FILTERED_DATA_SOURCES](http://msdn2.microsoft.com/en-us/library/5baae290-aead-4986-a7d4-0302931e0104) | filtereg.h | Vanara.PInvoke.SearchApi+FILTERED_DATA_SOURCES
[FILTERREGION](https://www.google.com/search?num=5&q=FILTERREGION+site%3Amicrosoft.com) | filter.h | Vanara.PInvoke.SearchApi+FILTERREGION
[INCREMENTAL_ACCESS_INFO](https://www.google.com/search?num=5&q=INCREMENTAL_ACCESS_INFO+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+INCREMENTAL_ACCESS_INFO
[ITEM_INFO](https://www.google.com/search?num=5&q=ITEM_INFO+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ITEM_INFO
[PROXY_INFO](https://www.google.com/search?num=5&q=PROXY_INFO+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+PROXY_INFO
[SEARCH_COLUMN_PROPERTIES](https://www.google.com/search?num=5&q=SEARCH_COLUMN_PROPERTIES+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+SEARCH_COLUMN_PROPERTIES
[SEARCH_ITEM_CHANGE](https://www.google.com/search?num=5&q=SEARCH_ITEM_CHANGE+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+SEARCH_ITEM_CHANGE
[SEARCH_ITEM_INDEXING_STATUS](https://www.google.com/search?num=5&q=SEARCH_ITEM_INDEXING_STATUS+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+SEARCH_ITEM_INDEXING_STATUS
[SEARCH_ITEM_PERSISTENT_CHANGE](https://www.google.com/search?num=5&q=SEARCH_ITEM_PERSISTENT_CHANGE+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+SEARCH_ITEM_PERSISTENT_CHANGE
[TIMEOUT_INFO](https://www.google.com/search?num=5&q=TIMEOUT_INFO+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+TIMEOUT_INFO
### Interfaces
Native Interface | Native DLL | Header | Managed Interface
--- | --- | --- | ---
[ICondition](https://www.google.com/search?num=5&q=ICondition+site%3Amicrosoft.com) | structuredquerycondition.h | Vanara.PInvoke.SearchApi+ICondition
[ICondition2](https://www.google.com/search?num=5&q=ICondition2+site%3Amicrosoft.com) | structuredquerycondition.h | Vanara.PInvoke.SearchApi+ICondition2
[IConditionFactory](https://www.google.com/search?num=5&q=IConditionFactory+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+IConditionFactory
[IConditionFactory2](https://www.google.com/search?num=5&q=IConditionFactory2+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+IConditionFactory2
[IEntity](https://www.google.com/search?num=5&q=IEntity+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+IEntity
[IEnumSearchRoots](https://www.google.com/search?num=5&q=IEnumSearchRoots+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IEnumSearchRoots
[IEnumSearchScopeRules](https://www.google.com/search?num=5&q=IEnumSearchScopeRules+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IEnumSearchScopeRules
[IFilter](https://www.google.com/search?num=5&q=IFilter+site%3Amicrosoft.com) | filter.h | Vanara.PInvoke.SearchApi+IFilter
[ILoadFilter](http://msdn2.microsoft.com/en-us/library/7ac51909-fa0e-4f97-8da0-0ab4c5de7d60) | filtereg.h | Vanara.PInvoke.SearchApi+ILoadFilter
[INamedEntity](https://www.google.com/search?num=5&q=INamedEntity+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+INamedEntity
[IOpLockStatus](https://www.google.com/search?num=5&q=IOpLockStatus+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IOpLockStatus
[IProtocolHandlerSite](https://www.google.com/search?num=5&q=IProtocolHandlerSite+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IProtocolHandlerSite
[IQueryParser](https://www.google.com/search?num=5&q=IQueryParser+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+IQueryParser
[IQueryParserManager](https://www.google.com/search?num=5&q=IQueryParserManager+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+IQueryParserManager
[IQuerySolution](https://www.google.com/search?num=5&q=IQuerySolution+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+IQuerySolution
[IRelationship](https://www.google.com/search?num=5&q=IRelationship+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+IRelationship
[IRichChunk](https://www.google.com/search?num=5&q=IRichChunk+site%3Amicrosoft.com) | structuredquerycondition.h | Vanara.PInvoke.SearchApi+IRichChunk
[IRowsetEvents](https://www.google.com/search?num=5&q=IRowsetEvents+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IRowsetEvents
[IRowsetPrioritization](https://www.google.com/search?num=5&q=IRowsetPrioritization+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IRowsetPrioritization
[ISchemaLocalizerSupport](https://www.google.com/search?num=5&q=ISchemaLocalizerSupport+site%3Amicrosoft.com) | | Vanara.PInvoke.SearchApi+ISchemaLocalizerSupport
[ISchemaProvider](https://www.google.com/search?num=5&q=ISchemaProvider+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+ISchemaProvider
[ISearchCatalogManager](https://www.google.com/search?num=5&q=ISearchCatalogManager+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchCatalogManager
[ISearchCatalogManager2](https://www.google.com/search?num=5&q=ISearchCatalogManager2+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchCatalogManager2
[ISearchCrawlScopeManager](https://www.google.com/search?num=5&q=ISearchCrawlScopeManager+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchCrawlScopeManager
[ISearchCrawlScopeManager2](https://www.google.com/search?num=5&q=ISearchCrawlScopeManager2+site%3Amicrosoft.com) | | Vanara.PInvoke.SearchApi+ISearchCrawlScopeManager2
[ISearchFolderItemFactory](http://msdn2.microsoft.com/en-us/library/a684b373-6de4-4b4a-bbae-85e1c5a7e04a) | shobjidl_core.h | Vanara.PInvoke.SearchApi+ISearchFolderItemFactory
[ISearchItemsChangedSink](https://www.google.com/search?num=5&q=ISearchItemsChangedSink+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchItemsChangedSink
[ISearchLanguageSupport](https://www.google.com/search?num=5&q=ISearchLanguageSupport+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchLanguageSupport
[ISearchManager](https://www.google.com/search?num=5&q=ISearchManager+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchManager
[ISearchManager2](https://www.google.com/search?num=5&q=ISearchManager2+site%3Amicrosoft.com) | | Vanara.PInvoke.SearchApi+ISearchManager2
[ISearchNotifyInlineSite](https://www.google.com/search?num=5&q=ISearchNotifyInlineSite+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchNotifyInlineSite
[ISearchPersistentItemsChangedSink](https://www.google.com/search?num=5&q=ISearchPersistentItemsChangedSink+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchPersistentItemsChangedSink
[ISearchProtocol](https://www.google.com/search?num=5&q=ISearchProtocol+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchProtocol
[ISearchProtocol2](https://www.google.com/search?num=5&q=ISearchProtocol2+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchProtocol2
[ISearchProtocolThreadContext](https://www.google.com/search?num=5&q=ISearchProtocolThreadContext+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchProtocolThreadContext
[ISearchQueryHelper](https://www.google.com/search?num=5&q=ISearchQueryHelper+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchQueryHelper
[ISearchRoot](https://www.google.com/search?num=5&q=ISearchRoot+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchRoot
[ISearchScopeRule](https://www.google.com/search?num=5&q=ISearchScopeRule+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchScopeRule
[ISearchViewChangedSink](https://www.google.com/search?num=5&q=ISearchViewChangedSink+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+ISearchViewChangedSink
[ITokenCollection](https://www.google.com/search?num=5&q=ITokenCollection+site%3Amicrosoft.com) | structuredquery.h | Vanara.PInvoke.SearchApi+ITokenCollection
[IUrlAccessor](https://www.google.com/search?num=5&q=IUrlAccessor+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IUrlAccessor
[IUrlAccessor2](https://www.google.com/search?num=5&q=IUrlAccessor2+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IUrlAccessor2
[IUrlAccessor3](https://www.google.com/search?num=5&q=IUrlAccessor3+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IUrlAccessor3
[IUrlAccessor4](https://www.google.com/search?num=5&q=IUrlAccessor4+site%3Amicrosoft.com) | searchapi.h | Vanara.PInvoke.SearchApi+IUrlAccessor4

6635
PInvoke/SearchApi/SearchApi.cs Normal file
View File

File diff suppressed because it is too large Load Diff

174
PInvoke/SearchApi/ShObjIdl.ISearchFolderItemFactory.cs Normal file
View File

@ -0,0 +1,174 @@
using System;
using System.Runtime.InteropServices;
using static Vanara.PInvoke.Ole32;
using static Vanara.PInvoke.Shell32;
namespace Vanara.PInvoke
{
public static partial class SearchApi
{
/// <summary>
/// Exposes methods that create and modify search folders. The Set methods are called first to set up the parameters of the search.
/// When not called, default values will be used instead. ISearchFolderItemFactory::GetIDList and
/// ISearchFolderItemFactory::GetShellItem return the two forms of the search specified by these parameters.
/// </summary>
/// <remarks>To implement this interface use class ID <c>CLSID_SearchFolderItemFactory</c>.</remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nn-shobjidl_core-isearchfolderitemfactory
[PInvokeData("shobjidl_core.h", MSDNShortId = "a684b373-6de4-4b4a-bbae-85e1c5a7e04a")]
[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("a0ffbc28-5482-4366-be27-3e81e78e06c2"), CoClass(typeof(SearchFolderItemFactory))]
public interface ISearchFolderItemFactory
{
/// <summary>Sets the search folder display name, as specified.</summary>
/// <param name="pszDisplayName">
/// <para>Type: <c>LPCWSTR</c></para>
/// <para>A pointer to a folder display name as a Unicode string.</para>
/// </param>
/// <remarks>Calling this method is required. A display name must be set.</remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setdisplayname
// HRESULT SetDisplayName( LPCWSTR pszDisplayName );
void SetDisplayName([MarshalAs(UnmanagedType.LPWStr)] string pszDisplayName);
/// <summary>Sets a search folder type ID, as specified.</summary>
/// <param name="ftid">
/// <para>Type: <c>FOLDERTYPEID</c></para>
/// <para>The FOLDERTYPEID, which is a <c>GUID</c> used to identify folder types within the system. The default is <c>FOLDERTYPID_Library</c></para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setfoldertypeid
// HRESULT SetFolderTypeID( FOLDERTYPEID ftid );
void SetFolderTypeID(FOLDERTYPEID ftid);
/// <summary>
/// Sets folder logical view mode. The default settings are based on the which is set by the
/// ISearchFolderItemFactory::SetFolderTypeID method.
/// </summary>
/// <param name="flvm">
/// <para>Type: <c>FOLDERLOGICALVIEWMODE</c></para>
/// <para>The FOLDERLOGICALVIEWMODE value.</para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setfolderlogicalviewmode
// HRESULT SetFolderLogicalViewMode( FOLDERLOGICALVIEWMODE flvm );
void SetFolderLogicalViewMode(FOLDERLOGICALVIEWMODE flvm);
/// <summary>
/// Sets the search folder icon size, as specified. The default settings are based on the which is set by the
/// ISearchFolderItemFactory::SetFolderTypeID method.
/// </summary>
/// <param name="iIconSize">
/// <para>Type: <c>int</c></para>
/// <para>The icon size.</para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-seticonsize
// HRESULT SetIconSize( int iIconSize );
void SetIconSize(int iIconSize);
/// <summary>
/// Creates a new column list whose columns are all visible, given an array of PROPERTYKEY structures. The default is based on <c>FolderTypeID</c>.
/// </summary>
/// <param name="cVisibleColumns">
/// <para>Type: <c>UINT</c></para>
/// <para>The number of array elements.</para>
/// </param>
/// <param name="rgKey">
/// <para>Type: <c>const PROPERTYKEY*</c></para>
/// <para>A pointer to an array of PROPERTYKEY structures.</para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setvisiblecolumns
// HRESULT SetVisibleColumns( UINT cVisibleColumns, const PROPERTYKEY *rgKey );
void SetVisibleColumns(uint cVisibleColumns, [In] PROPERTYKEY[] rgKey);
/// <summary>Creates a list of sort column directions, as specified.</summary>
/// <param name="cSortColumns">
/// <para>Type: <c>UINT</c></para>
/// <para>The number of sort columns.</para>
/// </param>
/// <param name="rgSortColumns">
/// <para>Type: <c>SORTCOLUMN*</c></para>
/// <para>A pointer to an array of SORTCOLUMN structures containing sort direction. The default is <c>PKEY_ItemNameDisplay</c>.</para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setsortcolumns
// HRESULT SetSortColumns( UINT cSortColumns, SORTCOLUMN *rgSortColumns );
void SetSortColumns(uint cSortColumns, [In] SORTCOLUMN[] rgSortColumns);
/// <summary>Sets a group column, as specified. If no group column is specified, no grouping occurs.</summary>
/// <param name="keyGroup">
/// <para>Type: <c>REFPROPERTYKEY</c></para>
/// <para>A reference to a group column PROPERTYKEY.</para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setgroupcolumn
// HRESULT SetGroupColumn( REFPROPERTYKEY keyGroup );
void SetGroupColumn(in PROPERTYKEY keyGroup);
/// <summary>
/// Creates a list of stack keys, as specified. If this method is not called, by default the folder will not be stacked.
/// </summary>
/// <param name="cStackKeys">
/// <para>Type: <c>UINT</c></para>
/// <para>The number of stacks keys.</para>
/// </param>
/// <param name="rgStackKeys">
/// <para>Type: <c>PROPERTYKEY*</c></para>
/// <para>A pointer to an array of PROPERTYKEY structures containing stack key information.</para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setstacks HRESULT
// SetStacks( UINT cStackKeys, PROPERTYKEY *rgStackKeys );
void SetStacks(uint cStackKeys, [In] PROPERTYKEY[] rgStackKeys);
/// <summary>Sets search scope, as specified.</summary>
/// <param name="psiaScope">
/// <para>Type: <c>IShellItemArray*</c></para>
/// <para>
/// A pointer to the list of locations to search. The search will include this location and all its subcontainers. The default is <c>FOLDERID_Profile</c>
/// </para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setscope HRESULT
// SetScope( IShellItemArray *psiaScope );
void SetScope([In] IShellItemArray psiaScope);
/// <summary>
/// Sets the ICondition of the search. When this method is not called, the resulting search will have no filters applied.
/// </summary>
/// <param name="pCondition">
/// <para>Type: <c>ICondition*</c></para>
/// <para>A pointer to an ICondition interface.</para>
/// </param>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-setcondition
// HRESULT SetCondition( ICondition *pCondition );
void SetCondition([In] ICondition pCondition);
/// <summary>Gets the search folder as a IShellItem.</summary>
/// <param name="riid">
/// <para>Type: <c>REFIID</c></para>
/// <para>A reference to the desired IID.</para>
/// </param>
/// <param name="ppv">
/// <para>Type: <c>void**</c></para>
/// <para>The IShellItem interface pointer specified in riid.</para>
/// </param>
/// <remarks>When the retrieved IShellItem is enumerated, it returns the search results.</remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-getshellitem
// HRESULT GetShellItem( REFIID riid, void **ppv );
[return: MarshalAs(UnmanagedType.IUnknown)]
object GetShellItem(in Guid riid);
/// <summary>Gets the search folder as an ITEMIDLIST.</summary>
/// <returns>
/// <para>Type: <c>PIDLIST_ABSOLUTE*</c></para>
/// <para>When this method returns successfully, contains a PIDL.</para>
/// </returns>
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-isearchfolderitemfactory-getidlist HRESULT
// GetIDList( PIDLIST_ABSOLUTE *ppidl );
PIDL GetIDList();
}
/// <summary>Extension method to simplify using the <see cref="ISearchFolderItemFactory.GetShellItem"/> method.</summary>
/// <typeparam name="T">Type of the interface to get.</typeparam>
/// <param name="sfif">An <see cref="ISearchFolderItemFactory"/> instance.</param>
/// <returns>Receives the interface pointer requested in <typeparamref name="T"/>.</returns>
public static T GetShellItem<T>(this ISearchFolderItemFactory sfif) where T : class => (T)sfif.GetShellItem(typeof(T).GUID);
/// <summary>CLSID_SearchFolderItemFactory</summary>
[PInvokeData("shobjidl_core.h", MSDNShortId = "a684b373-6de4-4b4a-bbae-85e1c5a7e04a")]
[ComImport, Guid("14010e02-bbbd-41f0-88e3-eda371216584"), ClassInterface(ClassInterfaceType.None)]
public class SearchFolderItemFactory { }
}
}

2019
PInvoke/SearchApi/StructuredQuery.cs Normal file
View File

File diff suppressed because it is too large Load Diff

887
PInvoke/SearchApi/StructuredQueryCondition.cs Normal file
View File

@ -0,0 +1,887 @@
using System;
using System.Runtime.InteropServices;
using System.Runtime.InteropServices.ComTypes;
using static Vanara.PInvoke.Ole32;
namespace Vanara.PInvoke
{
public static partial class SearchApi
{
/// <summary>
/// Provides a set of flags to be used with following methods to indicate the operation in ICondition::GetComparisonInfo,
/// ICondition2::GetLeafConditionInfo, IConditionFactory::MakeLeaf, IConditionFactory2::CreateBooleanLeaf,
/// IConditionFactory2::CreateIntegerLeaf, IConditionFactory2::MakeLeaf, IConditionFactory2::CreateStringLeaf, and IConditionGenerator::GenerateForLeaf.
/// </summary>
/// <remarks>
/// <para>
/// Provides a set of flags to be used with following methods to indicate the operation in ICondition::GetComparisonInfo,
/// ICondition2::GetLeafConditionInfo, IConditionFactory::MakeLeaf, IConditionFactory2::CreateBooleanLeaf,
/// IConditionFactory2::CreateIntegerLeaf, IConditionFactory2::MakeLeaf, IConditionFactory2::CreateStringLeaf, and IConditionGenerator::GenerateForLeaf.
/// </para>
/// <para>
/// In Windows 7, this enumeration is defined in structuredquerycondition.idl and structuredquerycondition.h. Prior to Windows 7 this
/// enumeration was declared in structuredquery.h and structuredquery.idl.
/// </para>
/// </remarks>
[PInvokeData("structuredquerycondition.h")]
public enum CONDITION_OPERATION
{
/// <summary>
/// An implicit comparison between the value of the property and the value of the constant. For an unresolved condition,
/// COP_IMPLICIT means that a user did not type an operation. In contrast, a resolved condition will always have a condition
/// other than the COP_IMPLICIT operation.
/// </summary>
COP_IMPLICIT,
/// <summary>The value of the property and the value of the constant must be equal.</summary>
COP_EQUAL,
/// <summary>The value of the property and the value of the constant must not be equal.</summary>
COP_NOTEQUAL,
/// <summary>The value of the property must be less than the value of the constant.</summary>
COP_LESSTHAN,
/// <summary>The value of the property must be greater than the value of the constant.</summary>
COP_GREATERTHAN,
/// <summary>The value of the property must be less than or equal to the value of the constant.</summary>
COP_LESSTHANOREQUAL,
/// <summary>The value of the property must be greater than or equal to the value of the constant.</summary>
COP_GREATERTHANOREQUAL,
/// <summary>The value of the property must begin with the value of the constant.</summary>
COP_VALUE_STARTSWITH,
/// <summary>The value of the property must end with the value of the constant.</summary>
COP_VALUE_ENDSWITH,
/// <summary>The value of the property must contain the value of the constant.</summary>
COP_VALUE_CONTAINS,
/// <summary>The value of the property must not contain the value of the constant.</summary>
COP_VALUE_NOTCONTAINS,
/// <summary>
/// The value of the property must match the value of the constant, where '?' matches any single character and '*' matches any
/// sequence of characters.
/// </summary>
COP_DOSWILDCARDS,
/// <summary>The value of the property must contain a word that is the value of the constant.</summary>
COP_WORD_EQUAL,
/// <summary>The value of the property must contain a word that begins with the value of the constant.</summary>
COP_WORD_STARTSWITH,
/// <summary>The application is free to interpret this in any suitable way.</summary>
COP_APPLICATION_SPECIFIC,
}
/// <summary>
/// Provides a set of flags to be used with the following methods to indicate the type of condition tree node:
/// ICondition::GetConditionType, IConditionFactory::MakeAndOr, IConditionFactory2::CreateCompoundFromArray, and IConditionFactory2::CreateCompoundFromObjectArray.
/// </summary>
/// <remarks>
/// <para>
/// In Windows 7, this enumeration is defined in structuredquerycondition.idl and structuredquerycondition.h. Prior to Windows 7 this
/// enumeration was declared in structuredquery.h and structuredquery.idl.
/// </para>
/// <para>
/// The StructuredQuerySample code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to read lines from the
/// console, parse them using the system schema, and display the resulting condition trees.
/// </para>
/// </remarks>
[PInvokeData("structuredquerycondition.h")]
public enum CONDITION_TYPE
{
/// <summary>Indicates that the values of the subterms are combined by "AND".</summary>
CT_AND_CONDITION,
/// <summary>Indicates that the values of the subterms are combined by "OR".</summary>
CT_OR_CONDITION,
/// <summary>Indicates a "NOT" comparison of subterms.</summary>
CT_NOT_CONDITION,
/// <summary>Indicates that the node is a comparison between a property and a constant value using a CONDITION_OPERATION.</summary>
CT_LEAF_CONDITION,
}
/// <summary>
/// Provides methods for retrieving information about a search condition. An <c>ICondition</c> object represents the result of
/// parsing an input string (using methods such as IQueryParser::Parse or IQuerySolution::GetQuery) into a tree of search condition
/// nodes. A node can be a logical AND, OR, or NOT for comparing subnodes, or it can be a leaf node comparing a property and a
/// constant value.
/// </summary>
/// <remarks>
/// <para>
/// Prior to Windows 7, this interface was only declared in structuredquery.h and structuredquery.idl. In Windows 7, this interface
/// is also defined in structuredquerycondition.idl and structuredquerycondition.h.
/// </para>
/// <para>
/// The StructuredQuerySample code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to read lines from the
/// console, parse them using the system schema, and display the resulting condition trees.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nn-structuredquerycondition-icondition
[PInvokeData("structuredquerycondition.h")]
[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("0FC988D4-C935-4b97-A973-46282EA175C8")]
public interface ICondition : IPersistStream
{
/// <summary>Retrieves the class identifier (CLSID) of the object.</summary>
/// <returns>
/// <para>
/// A pointer to the location that receives the CLSID on return. The CLSID is a globally unique identifier (GUID) that uniquely
/// represents an object class that defines the code that can manipulate the object's data.
/// </para>
/// <para>If the method succeeds, the return value is S_OK. Otherwise, it is E_FAIL.</para>
/// </returns>
/// <remarks>
/// <para>
/// The <c>GetClassID</c> method retrieves the class identifier (CLSID) for an object, used in later operations to load
/// object-specific code into the caller's context.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// A container application might call this method to retrieve the original CLSID of an object that it is treating as a different
/// class. Such a call would be necessary if a user performed an editing operation that required the object to be saved. If the
/// container were to save it using the treat-as CLSID, the original application would no longer be able to edit the object.
/// Typically, in this case, the container calls the OleSave helper function, which performs all the necessary steps. For this
/// reason, most container applications have no need to call this method directly.
/// </para>
/// <para>
/// The exception would be a container that provides an object handler for certain objects. In particular, a container
/// application should not get an object's CLSID and then use it to retrieve class specific information from the registry.
/// Instead, the container should use IOleObject and IDataObject interfaces to retrieve such class-specific information directly
/// from the object.
/// </para>
/// <para>Notes to Implementers</para>
/// <para>
/// Typically, implementations of this method simply supply a constant CLSID for an object. If, however, the object's
/// <c>TreatAs</c> registry key has been set by an application that supports emulation (and so is treating the object as one of a
/// different class), a call to <c>GetClassID</c> must supply the CLSID specified in the <c>TreatAs</c> key. For more information
/// on emulation, see CoTreatAsClass.
/// </para>
/// <para>
/// When an object is in the running state, the default handler calls an implementation of <c>GetClassID</c> that delegates the
/// call to the implementation in the object. When the object is not running, the default handler instead calls the ReadClassStg
/// function to read the CLSID that is saved in the object's storage.
/// </para>
/// <para>
/// If you are writing a custom object handler for your object, you might want to simply delegate this method to the default
/// handler implementation (see OleCreateDefaultHandler).
/// </para>
/// <para>URL Moniker Notes</para>
/// <para>This method returns CLSID_StdURLMoniker.</para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersist-getclassid HRESULT GetClassID( CLSID *pClassID );
new Guid GetClassID();
/// <summary>Determines whether an object has changed since it was last saved to its stream.</summary>
/// <returns>This method returns S_OK to indicate that the object has changed. Otherwise, it returns S_FALSE.</returns>
/// <remarks>
/// <para>
/// Use this method to determine whether an object should be saved before closing it. The dirty flag for an object is
/// conditionally cleared in the IPersistStream::Save method.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// You should treat any error return codes as an indication that the object has changed. Unless this method explicitly returns
/// S_FALSE, assume that the object must be saved.
/// </para>
/// <para>
/// Note that the OLE-provided implementations of the <c>IPersistStream::IsDirty</c> method in the OLE-provided moniker
/// interfaces always return S_FALSE because their internal state never changes.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-isdirty HRESULT IsDirty( );
[PreserveSig]
new HRESULT IsDirty();
/// <summary>Initializes an object from the stream where it was saved previously.</summary>
/// <param name="pstm">The PSTM.</param>
/// <remarks>
/// <para>
/// This method loads an object from its associated stream. The seek pointer is set as it was in the most recent
/// IPersistStream::Save method. This method can seek and read from the stream, but cannot write to it.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// Rather than calling <c>IPersistStream::Load</c> directly, you typically call the OleLoadFromStream function does the following:
/// </para>
/// <list type="number">
/// <item>
/// <term>Calls the ReadClassStm function to get the class identifier from the stream.</term>
/// </item>
/// <item>
/// <term>Calls the CoCreateInstance function to create an instance of the object.</term>
/// </item>
/// <item>
/// <term>Queries the instance for IPersistStream.</term>
/// </item>
/// <item>
/// <term>Calls <c>IPersistStream::Load</c>.</term>
/// </item>
/// </list>
/// <para>
/// The OleLoadFromStream function assumes that objects are stored in the stream with a class identifier followed by the object
/// data. This storage pattern is used by the generic, composite-moniker implementation provided by OLE.
/// </para>
/// <para>If the objects are not stored using this pattern, you must call the methods separately yourself.</para>
/// <para>URL Moniker Notes</para>
/// <para>
/// Initializes an URL moniker from data within a stream, usually stored there previously using its IPersistStream::Save (using
/// OleSaveToStream). The binary format of the URL moniker is its URL string in Unicode (may be a full or partial URL string, see
/// CreateURLMonikerEx for details). This is represented as a <c>ULONG</c> count of characters followed by that many Unicode characters.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-load HRESULT Load( IStream *pStm );
new void Load([In, MarshalAs(UnmanagedType.Interface)] IStream pstm);
/// <summary>Saves an object to the specified stream.</summary>
/// <param name="pstm">The PSTM.</param>
/// <param name="fClearDirty">
/// Indicates whether to clear the dirty flag after the save is complete. If <c>TRUE</c>, the flag should be cleared. If
/// <c>FALSE</c>, the flag should be left unchanged.
/// </param>
/// <remarks>
/// <para>
/// <c>IPersistStream::Save</c> saves an object into the specified stream and indicates whether the object should reset its dirty flag.
/// </para>
/// <para>
/// The seek pointer is positioned at the location in the stream at which the object should begin writing its data. The object
/// calls the ISequentialStream::Write method to write its data.
/// </para>
/// <para>
/// On exit, the seek pointer must be positioned immediately past the object data. The position of the seek pointer is undefined
/// if an error returns.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// Rather than calling <c>IPersistStream::Save</c> directly, you typically call the OleSaveToStream helper function which does
/// the following:
/// </para>
/// <list type="number">
/// <item>
/// <term>Calls GetClassID to get the object's CLSID.</term>
/// </item>
/// <item>
/// <term>Calls the WriteClassStm function to write the object's CLSID to the stream.</term>
/// </item>
/// <item>
/// <term>Calls <c>IPersistStream::Save</c>.</term>
/// </item>
/// </list>
/// <para>If you call these methods directly, you can write other data into the stream after the CLSID before calling <c>IPersistStream::Save</c>.</para>
/// <para>The OLE-provided implementation of IPersistStream follows this same pattern.</para>
/// <para>Notes to Implementers</para>
/// <para>
/// The <c>IPersistStream::Save</c> method does not write the CLSID to the stream. The caller is responsible for writing the CLSID.
/// </para>
/// <para>
/// The <c>IPersistStream::Save</c> method can read from, write to, and seek in the stream; but it must not seek to a location in
/// the stream before that of the seek pointer on entry.
/// </para>
/// <para>URL Moniker Notes</para>
/// <para>
/// Saves an URL moniker to a stream. The binary format of URL moniker is its URL string in Unicode (may be a full or partial URL
/// string, see CreateURLMonikerEx for details). This is represented as a <c>ULONG</c> count of characters followed by that many
/// Unicode characters.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-save HRESULT Save( IStream *pStm, BOOL
// fClearDirty );
new void Save([In, MarshalAs(UnmanagedType.Interface)] IStream pstm, [In, MarshalAs(UnmanagedType.Bool)] bool fClearDirty);
/// <summary>Retrieves the size of the stream needed to save the object.</summary>
/// <returns>The size in bytes of the stream needed to save this object, in bytes.</returns>
/// <remarks>
/// <para>
/// This method returns the size needed to save an object. You can call this method to determine the size and set the necessary
/// buffers before calling the IPersistStream::Save method.
/// </para>
/// <para>Notes to Implementers</para>
/// <para>
/// The <c>GetSizeMax</c> implementation should return a conservative estimate of the necessary size because the caller might
/// call the IPersistStream::Save method with a non-growable stream.
/// </para>
/// <para>URL Moniker Notes</para>
/// <para>
/// This method retrieves the maximum number of bytes in the stream that will be required by a subsequent call to
/// IPersistStream::Save. This value is sizeof(ULONG)==4 plus sizeof(WCHAR)*n where n is the length of the full or partial URL
/// string, including the NULL terminator.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-getsizemax HRESULT GetSizeMax(
// ULARGE_INTEGER *pcbSize );
new ulong GetSizeMax();
/// <summary>
/// Retrieves the condition type for this search condition node, identifying it as a logical AND, OR, or NOT, or as a leaf node.
/// </summary>
/// <returns>
/// <para>Type: <c>CONDITION_TYPE*</c></para>
/// <para>Receives the CONDITION_TYPE enumeration for this node.</para>
/// </returns>
/// <remarks>
/// The StructuredQuerySample code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to read lines from
/// the console, parse them using the system schema, and display the resulting condition trees.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getconditiontype
// HRESULT GetConditionType( CONDITION_TYPE *pNodeType );
CONDITION_TYPE GetConditionType();
/// <summary>
/// Retrieves a collection of the subconditions of the search condition node and the IID of the interface for enumerating the collection.
/// </summary>
/// <param name="riid">
/// <para>Type: <c>REFIID</c></para>
/// <para>
/// The desired IID of the enumerating interface: either IID_IEnumUnknown, IID_IEnumVARIANT or (for a negation condition) IID_ICondition.
/// </para>
/// </param>
/// <param name="ppv">
/// <para>Type: <c>void**</c></para>
/// <para>
/// Receives a collection of zero or more ICondition objects. Each object is a subcondition of this condition node. If <paramref
/// name="riid"/> was IID_ICondition and this is a negation condition, this parameter receives the single subcondition.
/// </para>
/// </param>
/// <remarks>
/// <para>
/// The <paramref name="riid"/> parameter must be the <c>GUID</c> of an IEnumUnknown or IEnumVARIANT interface or in the case of
/// a negation node, IID_ICondition.
/// </para>
/// <para>If the subcondition is a negation node, <paramref name="ppv"/> is set to an enumeration of one element.</para>
/// <para>If the node is a conjunction or disjunction node, <paramref name="ppv"/> is set to an enumeration of the subconditions.</para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getsubconditions
// HRESULT GetSubConditions( REFIID riid, void **ppv );
[return: MarshalAs(UnmanagedType.IUnknown)]
object GetSubConditions(in Guid riid);
/// <summary>Retrieves the property name, operation, and value from a leaf search condition node.</summary>
/// <param name="ppszPropertyName">
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives the name of the property of the leaf condition as a Unicode string.</para>
/// </param>
/// <param name="pcop">
/// <para>Type: <c>CONDITION_OPERATION*</c></para>
/// <para>Receives the operation of the leaf condition as a CONDITION_OPERATION enumeration.</para>
/// </param>
/// <param name="ppropvar">
/// <para>Type: <c>PROPVARIANT*</c></para>
/// <para>Receives the value of the leaf condition as a PROPVARIANT.</para>
/// </param>
/// <remarks>Any or all of the three parameters can be <c>NULL</c>.</remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getcomparisoninfo
// HRESULT GetComparisonInfo( LPWSTR *ppszPropertyName, CONDITION_OPERATION *pcop, PROPVARIANT *ppropvar );
void GetComparisonInfo([Out, MarshalAs(UnmanagedType.LPWStr)] out string ppszPropertyName, out CONDITION_OPERATION pcop, [In, Out] PROPVARIANT ppropvar);
/// <summary>Retrieves the semantic type of the value of the search condition node.</summary>
/// <returns>
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives either a pointer to the semantic type of the value as a Unicode string or <c>NULL</c>.</para>
/// </returns>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getvaluetype
// HRESULT GetValueType( LPWSTR *ppszValueTypeName );
[return: MarshalAs(UnmanagedType.LPWStr)]
string GetValueType();
/// <summary>Retrieves the character-normalized value of the search condition node.</summary>
/// <returns>
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives a pointer to a Unicode string representation of the value.</para>
/// </returns>
/// <remarks>
/// In <c>Windows 7 and later</c>, if the value of the leaf node is <c>VT_EMPTY</c>, ppwszNormalization points to an empty
/// string. If the value is a string, such as VT_LPWSTR, VT_BSTR or VT_LPSTR, then ppwszNormalization is set to a
/// character-normalized form of the value. In other cases, ppwszNormalization is set to some other character-normalized string
/// representation of the value.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getvaluenormalization
// HRESULT GetValueNormalization( LPWSTR *ppszNormalization );
[return: MarshalAs(UnmanagedType.LPWStr)]
string GetValueNormalization();
/// <summary>
/// For a leaf node, <c>ICondition::GetInputTerms</c> retrieves information about what parts (or ranges) of the input string
/// produced the property, the operation, and the value for the search condition node.
/// </summary>
/// <param name="ppPropertyTerm">
/// <para>Type: <c>IRichChunk**</c></para>
/// <para>
/// Receives a pointer to an IRichChunk interface that provides information about what part of the input string produced the
/// property of the leaf node, if that can be determined; otherwise, this parameter is set to <c>NULL</c>.
/// </para>
/// </param>
/// <param name="ppOperationTerm">
/// <para>Type: <c>IRichChunk**</c></para>
/// <para>
/// Receives a pointer to an IRichChunk interface that provides information about what part of the input string produced the
/// operation of the leaf node, if that can be determined; otherwise, this parameter is set to <c>NULL</c>.
/// </para>
/// </param>
/// <param name="ppValueTerm">
/// <para>Type: <c>IRichChunk**</c></para>
/// <para>
/// Receives a pointer to an IRichChunk interface that provides information about what part of the input string produced the
/// value of the leaf node, if that can be determined; otherwise, this parameter is set to <c>NULL</c>.
/// </para>
/// </param>
/// <remarks>
/// <para>Any or all of the parameters ppPropertyTerm, ppOperationTerm and ppValueTerm can be <c>NULL</c>.</para>
/// <para>
/// Each IRichChunk object retrieved by this method represents a range of tokens from the input string. The range tokens
/// identifies the substring that produced the property, operation, or value of the input string. The <c>IRichChunk</c>'s
/// PROPVARIANT out parameter is not used.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getinputterms
// HRESULT GetInputTerms( IRichChunk **ppPropertyTerm, IRichChunk **ppOperationTerm, IRichChunk **ppValueTerm );
void GetInputTerms(out IRichChunk ppPropertyTerm, out IRichChunk ppOperationTerm, out IRichChunk ppValueTerm);
/// <summary>Creates a deep copy of this ICondition object.</summary>
/// <returns>
/// <para>Type: <c>HRESULT</c></para>
/// <para>If this method succeeds, it returns <c>S_OK</c>. Otherwise, it returns an <c>HRESULT</c> error code.</para>
/// </returns>
/// <remarks>
/// Because there are no methods for modifying an ICondition, there are few occasions when this method is necessary. In many
/// cases it is adequate to call the IUnknown::QueryInterface method on the <c>ICondition</c> to obtain an additional reference
/// to the same object.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-clone
// HRESULT Clone( ICondition **ppc );
ICondition Clone();
}
/// <summary>
/// Extends the functionality of the ICondition interface. <c>ICondition2</c> provides methods for retrieving information about a search condition.
/// </summary>
/// <seealso cref="Vanara.PInvoke.Shell32.ICondition" />
/// <remarks>
/// The StructuredQuerySample code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to read lines from the console, parse them using the system schema, and display the resulting condition trees.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nn-structuredquerycondition-icondition2
[PInvokeData("structuredquerycondition.h", MSDNShortId = "")]
[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("0DB8851D-2E5B-47eb-9208-D28C325A01D7")]
public interface ICondition2 : ICondition
{
/// <summary>Retrieves the class identifier (CLSID) of the object.</summary>
/// <returns>
/// <para>
/// A pointer to the location that receives the CLSID on return. The CLSID is a globally unique identifier (GUID) that uniquely
/// represents an object class that defines the code that can manipulate the object's data.
/// </para>
/// <para>If the method succeeds, the return value is S_OK. Otherwise, it is E_FAIL.</para>
/// </returns>
/// <remarks>
/// <para>
/// The <c>GetClassID</c> method retrieves the class identifier (CLSID) for an object, used in later operations to load
/// object-specific code into the caller's context.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// A container application might call this method to retrieve the original CLSID of an object that it is treating as a different
/// class. Such a call would be necessary if a user performed an editing operation that required the object to be saved. If the
/// container were to save it using the treat-as CLSID, the original application would no longer be able to edit the object.
/// Typically, in this case, the container calls the OleSave helper function, which performs all the necessary steps. For this
/// reason, most container applications have no need to call this method directly.
/// </para>
/// <para>
/// The exception would be a container that provides an object handler for certain objects. In particular, a container
/// application should not get an object's CLSID and then use it to retrieve class specific information from the registry.
/// Instead, the container should use IOleObject and IDataObject interfaces to retrieve such class-specific information directly
/// from the object.
/// </para>
/// <para>Notes to Implementers</para>
/// <para>
/// Typically, implementations of this method simply supply a constant CLSID for an object. If, however, the object's
/// <c>TreatAs</c> registry key has been set by an application that supports emulation (and so is treating the object as one of a
/// different class), a call to <c>GetClassID</c> must supply the CLSID specified in the <c>TreatAs</c> key. For more information
/// on emulation, see CoTreatAsClass.
/// </para>
/// <para>
/// When an object is in the running state, the default handler calls an implementation of <c>GetClassID</c> that delegates the
/// call to the implementation in the object. When the object is not running, the default handler instead calls the ReadClassStg
/// function to read the CLSID that is saved in the object's storage.
/// </para>
/// <para>
/// If you are writing a custom object handler for your object, you might want to simply delegate this method to the default
/// handler implementation (see OleCreateDefaultHandler).
/// </para>
/// <para>URL Moniker Notes</para>
/// <para>This method returns CLSID_StdURLMoniker.</para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersist-getclassid HRESULT GetClassID( CLSID *pClassID );
new Guid GetClassID();
/// <summary>Determines whether an object has changed since it was last saved to its stream.</summary>
/// <returns>This method returns S_OK to indicate that the object has changed. Otherwise, it returns S_FALSE.</returns>
/// <remarks>
/// <para>
/// Use this method to determine whether an object should be saved before closing it. The dirty flag for an object is
/// conditionally cleared in the IPersistStream::Save method.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// You should treat any error return codes as an indication that the object has changed. Unless this method explicitly returns
/// S_FALSE, assume that the object must be saved.
/// </para>
/// <para>
/// Note that the OLE-provided implementations of the <c>IPersistStream::IsDirty</c> method in the OLE-provided moniker
/// interfaces always return S_FALSE because their internal state never changes.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-isdirty HRESULT IsDirty( );
[PreserveSig]
new HRESULT IsDirty();
/// <summary>Initializes an object from the stream where it was saved previously.</summary>
/// <param name="pstm">The PSTM.</param>
/// <remarks>
/// <para>
/// This method loads an object from its associated stream. The seek pointer is set as it was in the most recent
/// IPersistStream::Save method. This method can seek and read from the stream, but cannot write to it.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// Rather than calling <c>IPersistStream::Load</c> directly, you typically call the OleLoadFromStream function does the following:
/// </para>
/// <list type="number">
/// <item>
/// <term>Calls the ReadClassStm function to get the class identifier from the stream.</term>
/// </item>
/// <item>
/// <term>Calls the CoCreateInstance function to create an instance of the object.</term>
/// </item>
/// <item>
/// <term>Queries the instance for IPersistStream.</term>
/// </item>
/// <item>
/// <term>Calls <c>IPersistStream::Load</c>.</term>
/// </item>
/// </list>
/// <para>
/// The OleLoadFromStream function assumes that objects are stored in the stream with a class identifier followed by the object
/// data. This storage pattern is used by the generic, composite-moniker implementation provided by OLE.
/// </para>
/// <para>If the objects are not stored using this pattern, you must call the methods separately yourself.</para>
/// <para>URL Moniker Notes</para>
/// <para>
/// Initializes an URL moniker from data within a stream, usually stored there previously using its IPersistStream::Save (using
/// OleSaveToStream). The binary format of the URL moniker is its URL string in Unicode (may be a full or partial URL string, see
/// CreateURLMonikerEx for details). This is represented as a <c>ULONG</c> count of characters followed by that many Unicode characters.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-load HRESULT Load( IStream *pStm );
new void Load([In, MarshalAs(UnmanagedType.Interface)] IStream pstm);
/// <summary>Saves an object to the specified stream.</summary>
/// <param name="pstm">The PSTM.</param>
/// <param name="fClearDirty">
/// Indicates whether to clear the dirty flag after the save is complete. If <c>TRUE</c>, the flag should be cleared. If
/// <c>FALSE</c>, the flag should be left unchanged.
/// </param>
/// <remarks>
/// <para>
/// <c>IPersistStream::Save</c> saves an object into the specified stream and indicates whether the object should reset its dirty flag.
/// </para>
/// <para>
/// The seek pointer is positioned at the location in the stream at which the object should begin writing its data. The object
/// calls the ISequentialStream::Write method to write its data.
/// </para>
/// <para>
/// On exit, the seek pointer must be positioned immediately past the object data. The position of the seek pointer is undefined
/// if an error returns.
/// </para>
/// <para>Notes to Callers</para>
/// <para>
/// Rather than calling <c>IPersistStream::Save</c> directly, you typically call the OleSaveToStream helper function which does
/// the following:
/// </para>
/// <list type="number">
/// <item>
/// <term>Calls GetClassID to get the object's CLSID.</term>
/// </item>
/// <item>
/// <term>Calls the WriteClassStm function to write the object's CLSID to the stream.</term>
/// </item>
/// <item>
/// <term>Calls <c>IPersistStream::Save</c>.</term>
/// </item>
/// </list>
/// <para>If you call these methods directly, you can write other data into the stream after the CLSID before calling <c>IPersistStream::Save</c>.</para>
/// <para>The OLE-provided implementation of IPersistStream follows this same pattern.</para>
/// <para>Notes to Implementers</para>
/// <para>
/// The <c>IPersistStream::Save</c> method does not write the CLSID to the stream. The caller is responsible for writing the CLSID.
/// </para>
/// <para>
/// The <c>IPersistStream::Save</c> method can read from, write to, and seek in the stream; but it must not seek to a location in
/// the stream before that of the seek pointer on entry.
/// </para>
/// <para>URL Moniker Notes</para>
/// <para>
/// Saves an URL moniker to a stream. The binary format of URL moniker is its URL string in Unicode (may be a full or partial URL
/// string, see CreateURLMonikerEx for details). This is represented as a <c>ULONG</c> count of characters followed by that many
/// Unicode characters.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-save HRESULT Save( IStream *pStm, BOOL
// fClearDirty );
new void Save([In, MarshalAs(UnmanagedType.Interface)] IStream pstm, [In, MarshalAs(UnmanagedType.Bool)] bool fClearDirty);
/// <summary>Retrieves the size of the stream needed to save the object.</summary>
/// <returns>The size in bytes of the stream needed to save this object, in bytes.</returns>
/// <remarks>
/// <para>
/// This method returns the size needed to save an object. You can call this method to determine the size and set the necessary
/// buffers before calling the IPersistStream::Save method.
/// </para>
/// <para>Notes to Implementers</para>
/// <para>
/// The <c>GetSizeMax</c> implementation should return a conservative estimate of the necessary size because the caller might
/// call the IPersistStream::Save method with a non-growable stream.
/// </para>
/// <para>URL Moniker Notes</para>
/// <para>
/// This method retrieves the maximum number of bytes in the stream that will be required by a subsequent call to
/// IPersistStream::Save. This value is sizeof(ULONG)==4 plus sizeof(WCHAR)*n where n is the length of the full or partial URL
/// string, including the NULL terminator.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/objidl/nf-objidl-ipersiststream-getsizemax HRESULT GetSizeMax(
// ULARGE_INTEGER *pcbSize );
new ulong GetSizeMax();
/// <summary>
/// Retrieves the condition type for this search condition node, identifying it as a logical AND, OR, or NOT, or as a leaf node.
/// </summary>
/// <returns>
/// <para>Type: <c>CONDITION_TYPE*</c></para>
/// <para>Receives the CONDITION_TYPE enumeration for this node.</para>
/// </returns>
/// <remarks>
/// The StructuredQuerySample code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to read lines from
/// the console, parse them using the system schema, and display the resulting condition trees.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getconditiontype
// HRESULT GetConditionType( CONDITION_TYPE *pNodeType );
new CONDITION_TYPE GetConditionType();
/// <summary>
/// Retrieves a collection of the subconditions of the search condition node and the IID of the interface for enumerating the collection.
/// </summary>
/// <param name="riid">
/// <para>Type: <c>REFIID</c></para>
/// <para>
/// The desired IID of the enumerating interface: either IID_IEnumUnknown, IID_IEnumVARIANT or (for a negation condition) IID_ICondition.
/// </para>
/// </param>
/// <param name="ppv">
/// <para>Type: <c>void**</c></para>
/// <para>
/// Receives a collection of zero or more ICondition objects. Each object is a subcondition of this condition node. If <paramref
/// name="riid"/> was IID_ICondition and this is a negation condition, this parameter receives the single subcondition.
/// </para>
/// </param>
/// <remarks>
/// <para>
/// The <paramref name="riid"/> parameter must be the <c>GUID</c> of an IEnumUnknown or IEnumVARIANT interface or in the case of
/// a negation node, IID_ICondition.
/// </para>
/// <para>If the subcondition is a negation node, <paramref name="ppv"/> is set to an enumeration of one element.</para>
/// <para>If the node is a conjunction or disjunction node, <paramref name="ppv"/> is set to an enumeration of the subconditions.</para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getsubconditions
// HRESULT GetSubConditions( REFIID riid, void **ppv );
[return: MarshalAs(UnmanagedType.IUnknown)]
new object GetSubConditions(in Guid riid);
/// <summary>Retrieves the property name, operation, and value from a leaf search condition node.</summary>
/// <param name="ppszPropertyName">
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives the name of the property of the leaf condition as a Unicode string.</para>
/// </param>
/// <param name="pcop">
/// <para>Type: <c>CONDITION_OPERATION*</c></para>
/// <para>Receives the operation of the leaf condition as a CONDITION_OPERATION enumeration.</para>
/// </param>
/// <param name="ppropvar">
/// <para>Type: <c>PROPVARIANT*</c></para>
/// <para>Receives the value of the leaf condition as a PROPVARIANT.</para>
/// </param>
/// <remarks>Any or all of the three parameters can be <c>NULL</c>.</remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getcomparisoninfo
// HRESULT GetComparisonInfo( LPWSTR *ppszPropertyName, CONDITION_OPERATION *pcop, PROPVARIANT *ppropvar );
new void GetComparisonInfo([Out, MarshalAs(UnmanagedType.LPWStr)] out string ppszPropertyName, out CONDITION_OPERATION pcop, [In, Out] PROPVARIANT ppropvar);
/// <summary>Retrieves the semantic type of the value of the search condition node.</summary>
/// <returns>
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives either a pointer to the semantic type of the value as a Unicode string or <c>NULL</c>.</para>
/// </returns>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getvaluetype
// HRESULT GetValueType( LPWSTR *ppszValueTypeName );
[return: MarshalAs(UnmanagedType.LPWStr)]
new string GetValueType();
/// <summary>Retrieves the character-normalized value of the search condition node.</summary>
/// <returns>
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives a pointer to a Unicode string representation of the value.</para>
/// </returns>
/// <remarks>
/// In <c>Windows 7 and later</c>, if the value of the leaf node is <c>VT_EMPTY</c>, ppwszNormalization points to an empty
/// string. If the value is a string, such as VT_LPWSTR, VT_BSTR or VT_LPSTR, then ppwszNormalization is set to a
/// character-normalized form of the value. In other cases, ppwszNormalization is set to some other character-normalized string
/// representation of the value.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getvaluenormalization
// HRESULT GetValueNormalization( LPWSTR *ppszNormalization );
[return: MarshalAs(UnmanagedType.LPWStr)]
new string GetValueNormalization();
/// <summary>
/// For a leaf node, <c>ICondition::GetInputTerms</c> retrieves information about what parts (or ranges) of the input string
/// produced the property, the operation, and the value for the search condition node.
/// </summary>
/// <param name="ppPropertyTerm">
/// <para>Type: <c>IRichChunk**</c></para>
/// <para>
/// Receives a pointer to an IRichChunk interface that provides information about what part of the input string produced the
/// property of the leaf node, if that can be determined; otherwise, this parameter is set to <c>NULL</c>.
/// </para>
/// </param>
/// <param name="ppOperationTerm">
/// <para>Type: <c>IRichChunk**</c></para>
/// <para>
/// Receives a pointer to an IRichChunk interface that provides information about what part of the input string produced the
/// operation of the leaf node, if that can be determined; otherwise, this parameter is set to <c>NULL</c>.
/// </para>
/// </param>
/// <param name="ppValueTerm">
/// <para>Type: <c>IRichChunk**</c></para>
/// <para>
/// Receives a pointer to an IRichChunk interface that provides information about what part of the input string produced the
/// value of the leaf node, if that can be determined; otherwise, this parameter is set to <c>NULL</c>.
/// </para>
/// </param>
/// <remarks>
/// <para>Any or all of the parameters ppPropertyTerm, ppOperationTerm and ppValueTerm can be <c>NULL</c>.</para>
/// <para>
/// Each IRichChunk object retrieved by this method represents a range of tokens from the input string. The range tokens
/// identifies the substring that produced the property, operation, or value of the input string. The <c>IRichChunk</c>'s
/// PROPVARIANT out parameter is not used.
/// </para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getinputterms
// HRESULT GetInputTerms( IRichChunk **ppPropertyTerm, IRichChunk **ppOperationTerm, IRichChunk **ppValueTerm );
new void GetInputTerms(out IRichChunk ppPropertyTerm, out IRichChunk ppOperationTerm, out IRichChunk ppValueTerm);
/// <summary>Creates a deep copy of this ICondition object.</summary>
/// <returns>
/// <para>Type: <c>HRESULT</c></para>
/// <para>If this method succeeds, it returns <c>S_OK</c>. Otherwise, it returns an <c>HRESULT</c> error code.</para>
/// </returns>
/// <remarks>
/// Because there are no methods for modifying an ICondition, there are few occasions when this method is necessary. In many
/// cases it is adequate to call the IUnknown::QueryInterface method on the <c>ICondition</c> to obtain an additional reference
/// to the same object.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-clone
// HRESULT Clone( ICondition **ppc );
new ICondition Clone();
/// <summary>
/// <para>Retrieves the property name, operation, and value from a leaf search condition node.</para>
/// </summary>
/// <returns>
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives the name of the locale of the leaf condition as a Unicode string. This parameter can be <c>NULL</c>.</para>
/// </returns>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition2-getlocale
// HRESULT GetLocale( LPWSTR *ppszLocaleName );
[PInvokeData("structuredquerycondition.h", MSDNShortId = "")]
string GetLocale();
/// <summary>
/// Retrieves the property name, operation, and value from a leaf search condition node.
/// </summary>
/// <param name="ppropkey"><para>Type: <c>PROPERTYKEY*</c></para><para>Receives the name of the property of the leaf condition as a PROPERTYKEY.</para></param>
/// <param name="pcop"><para>Type: <c>CONDITION_OPERATION*</c></para><para>Receives the operation of the leaf condition as a CONDITION_OPERATION enumeration.</para></param>
/// <param name="ppropvar"><para>Type: <c>PROPVARIANT*</c></para><para>Receives the property value of the leaf condition as a PROPVARIANT.</para></param>
/// <remarks>
/// <para>Any or all of the three parameters can be <c>NULL</c>.</para><para>The StructuredQuerySample code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to read lines from the console, parse them using the system schema, and display the resulting condition trees.</para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition2-getleafconditioninfo
// HRESULT GetLeafConditionInfo( PROPERTYKEY *ppropkey, CONDITION_OPERATION *pcop, PROPVARIANT *ppropvar );
[PInvokeData("structuredquerycondition.h", MSDNShortId = "")]
void GetLeafConditionInfo(out PROPERTYKEY ppropkey, out CONDITION_OPERATION pcop, [Out] PROPVARIANT ppropvar);
}
/// <summary>Represents a chunk of data as a string and a PROPVARIANT value.</summary>
/// <remarks>
/// In Windows 7, this interface is defined in structuredquerycondition.idl and structuredquerycondition.h. Prior to Windows 7 this
/// interface was declared in structuredquery.h and structuredquery.idl.
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nn-structuredquerycondition-irichchunk
[PInvokeData("structuredquerycondition.h")]
[ComImport, Guid("4FDEF69C-DBC9-454e-9910-B34F3C64B510"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IRichChunk
{
/// <summary>
/// <para>Retrieves the PROPVARIANT and input string that represents a chunk of data.</para>
/// </summary>
/// <param name="pFirstPos">
/// <para>Type: <c>ULONG*</c></para>
/// <para>Receives the zero-based starting position of the range. This parameter can be <c>NULL</c>.</para>
/// </param>
/// <param name="pLength">
/// <para>Type: <c>ULONG*</c></para>
/// <para>Receives the length of the range. This parameter can be <c>NULL</c>.</para>
/// </param>
/// <param name="ppsz">
/// <para>Type: <c>LPWSTR*</c></para>
/// <para>Receives the associated Unicode string value, or <c>NULL</c> if not available.</para>
/// </param>
/// <param name="pValue">
/// <para>Type: <c>PROPVARIANT*</c></para>
/// <para>Receives the associated PROPVARIANT value, or <c>VT_EMPTY</c> if not available. This parameter can be <c>NULL</c>.</para>
/// </param>
/// <returns>
/// <para>Type: <c>HRESULT</c></para>
/// <para>If this method succeeds, it returns <c>S_OK</c>. Otherwise, it returns an <c>HRESULT</c> error code.</para>
/// </returns>
/// <remarks>
/// <para>Prior to Windows 7, this was declared in structuredquery.idl and structuredquery.h.</para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-irichchunk-getdata
// HRESULT GetData( ULONG *pFirstPos, ULONG *pLength, LPWSTR *ppsz, PROPVARIANT *pValue );
void GetData(out uint pFirstPos, out uint pLength, [Out, MarshalAs(UnmanagedType.LPWStr)] out string ppsz, [In, Out] PROPVARIANT pValue);
}
/// <summary>
/// Retrieves a collection of the subconditions of the search condition node and the IID of the interface for enumerating the collection.
/// </summary>
/// <typeparam name="T">
/// The desired type of the enumerating interface: either IID_IEnumUnknown, IID_IEnumVARIANT or (for a negation condition) IID_ICondition.
/// </typeparam>
/// <param name="c">The <see cref="ICondition"/> instance.</param>
/// <returns>
/// Receives a collection of zero or more ICondition objects. Each object is a subcondition of this condition node. If
/// <typeparamref name="T"/> was IID_ICondition and this is a negation condition, this parameter receives the single subcondition.
/// </returns>
/// <remarks>
/// <para>If the subcondition is a negation node, the return value is set to an enumeration of one element.</para>
/// <para>If the node is a conjunction or disjunction node, the return value is set to an enumeration of the subconditions.</para>
/// </remarks>
// https://docs.microsoft.com/en-us/windows/desktop/api/structuredquerycondition/nf-structuredquerycondition-icondition-getsubconditions
// HRESULT GetSubConditions( REFIID riid, void **ppv );
public static T GetSubConditions<T>(this ICondition c) where T : class => (T)c.GetSubConditions(typeof(T).GUID);
}
}

60
PInvoke/SearchApi/Vanara.PInvoke.SearchApi.csproj Normal file
View File

@ -0,0 +1,60 @@
<?xml version="1.0" encoding="utf-8"?>
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<Description>PInvoke API (methods, structures and constants imported from Windows Search.</Description>
<Copyright>Copyright © 2017-2019</Copyright>
<AssemblyTitle>$(AssemblyName)</AssemblyTitle>
<VersionPrefix>2.3.9</VersionPrefix>
<TargetFrameworks>net20;net35;net40;net45</TargetFrameworks>
<AssemblyName>Vanara.PInvoke.SearchApi</AssemblyName>
<PackageId>$(AssemblyName)</PackageId>
<RootNamespace>Vanara.PInvoke</RootNamespace>
<Authors>David Hall</Authors>
<PackageProjectUrl>https://github.com/dahall/vanara</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageIconUrl>https://raw.githubusercontent.com/dahall/Vanara/master/docs/icons/Vanara48x48.png</PackageIconUrl>
<RepositoryUrl>https://github.com/dahall/vanara</RepositoryUrl>
<RepositoryType>Git</RepositoryType>
<PackageTags>pinvoke;vanara;net-extensions;interop</PackageTags>
<NeutralLanguage>en-US</NeutralLanguage>
<IncludeSource>true</IncludeSource>
<IncludeSymbols>true</IncludeSymbols>
<Company>GitHub Community</Company>
<Product>Vanara</Product>
<AllowUnsafeBlocks>True</AllowUnsafeBlocks>
<PackageReleaseNotes>Currently implements:
Structures
AUTHENTICATION_INFO, FILTERED_DATA_SOURCES, FILTERREGION, INCREMENTAL_ACCESS_INFO, ITEM_INFO, PROXY_INFO, SEARCH_COLUMN_PROPERTIES, SEARCH_ITEM_CHANGE, SEARCH_ITEM_INDEXING_STATUS, SEARCH_ITEM_PERSISTENT_CHANGE, TIMEOUT_INFO
Interfaces
IEnumSearchRoots, IEnumSearchScopeRules, IFilter, ILoadFilter, IOpLockStatus, IProtocolHandlerSite, IRowsetEvents, IRowsetPrioritization, ISearchCatalogManager, ISearchCatalogManager2, ISearchCrawlScopeManager, ISearchCrawlScopeManager2, ISearchItemsChangedSink, ISearchLanguageSupport, ISearchManager, ISearchManager2, ISearchNotifyInlineSite, ISearchPersistentItemsChangedSink, ISearchProtocol, ISearchProtocol2, ISearchProtocolThreadContext, ISearchQueryHelper, ISearchRoot, ISearchScopeRule, ISearchViewChangedSink, IUrlAccessor, IUrlAccessor2, IUrlAccessor3, IUrlAccessor4, ISearchFolderItemFactory, IConditionFactory, IConditionFactory2, IEntity, INamedEntity, IQueryParser, IQueryParserManager, IQuerySolution, IRelationship, ISchemaLocalizerSupport, ISchemaProvider, ITokenCollection, ICondition, ICondition2, IRichChunk
</PackageReleaseNotes>
<LangVersion>latest</LangVersion>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>..\..\Vanara.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)'=='Release'">
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
</PropertyGroup>
<ItemGroup Condition=" '$(TargetFramework)' == 'net20' ">
<Reference Include="System" />
</ItemGroup>
<ItemGroup Condition=" '$(TargetFramework)' == 'net35' ">
<Reference Include="System" />
</ItemGroup>
<ItemGroup Condition=" '$(TargetFramework)' == 'net40' ">
<Reference Include="System" />
</ItemGroup>
<ItemGroup Condition=" '$(TargetFramework)' == 'net45' ">
<Reference Include="System" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\Core\Vanara.Core.csproj" />
<ProjectReference Include="..\Shared\Vanara.PInvoke.Shared.csproj" />
<ProjectReference Include="..\Ole\Vanara.PInvoke.Ole.csproj" />
<ProjectReference Include="..\Shell32\Vanara.PInvoke.Shell32.csproj" />
</ItemGroup>
</Project>