archive
/
windows-xp
mirror of https://github.com/tongzx/nt5src
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6 Commits
1 Branch
0 Tags
2.0 GiB
Tree: daad8a087a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'daad8a087a'
${ noResults }
windows-xp/Source/XPSP1/NT/inetsrv/query/ifilter/isfilt.htm

256 lines
9.9 KiB
Raw Normal View History

Add source files
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
  3. <html>
  5. <head>
  6. <title>IFilter Interface in Index Server</title>
  7. <meta name="GENERATOR" content="Microsoft FrontPage 1.1">
  8. </head>
  10. <body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080">
  11. <table>
  12. <tr><td valign=top><img src="idx_logo.gif" align=bottom width=166 height=69> </td><td valign=top><h1><i>IFilter Interface in Index Server</i></h1>
  13. <p align=center><strong><i>Windows Design Team, September 7, 1996</i></strong> </p>
  14. </td></tr>
  15. </table>
  16. <p>This document describes use of the IFilter interface in Microsoft Index Server.</p>
  17. <p>&#160;</p>
  18. <hr>
  19. <h1>Contents</h1>
  20. <blockquote>
  21. <p><a href="#Introduction">Introduction</a></p>
  22. <p><a href="#Persistent Handlers">Persistent Handlers</a></p>
  23. <p><a href="#Pseudo-Persistent Handler API">Pseudo-Persistent Handler API</a></p>
  24. <p><a href="#Recommended Properties">Recommended Properties</a></p>
  25. <blockquote>
  26. <p><a href="#Title">Title</a></p>
  27. <p><a href="#Description">Description</a></p>
  28. <p><a href="#Office Summary Information">Office Summary Information</a></p>
  29. </blockquote>
  30. </blockquote>
  31. <hr>
  32. <h1><a name="Introduction">Introduction</a></h1>
  33. <p>This document is an addendum to the IFilter interface specification. It describes additional API and conventions specific to the
  34. Microsoft Index Server. </p>
  35. <h1><a name="Persistent Handlers">Persistent Handlers</a></h1>
  36. <p>Microsoft Index Server assumes implementations of the IFilter interface are registered as <i>persistent handlers</i> for OLE classes. The
  37. specifics of the persistent handler mechanism may change in future releases of Windows/NT or Index Server, but the API described
  38. below will continue to be supported. </p>
  39. <p>A persistent handler provides the same service for the persistent image of an object that the OLE running object table provides for the
  40. loaded, in-memory image. The persistent handler is the broker between the persistent state of an object and clients wishing to access
  41. that state. It is responsible for coordinating multiple client access to the persistent state of an object. </p>
  42. <p>Multiple handlers may be defined to provide behavior for a single persistent object. Each <i>interface</i> may specify a unique handler for
  43. only that interface. Potentially, multiple handlers which are ignorant of each other may all operate on the persistent image of the same
  44. object. It is the responsibility of the persistent handler to load the correct implementation for each interface. </p>
  45. <p>The following registry entries are sufficient to load the implementation of IFilter for objects of type SampleObject. </p>
  46. <p><tt>\Registry\MACHINE\SOFTWARE\Classes</tt> </p>
  47. <blockquote>
  48. <p><tt>.sam</tt> </p>
  49. </blockquote>
  50. <blockquote>
  51. <blockquote>
  52. <p><tt>= REG_SZ SampleFile</tt> </p>
  53. </blockquote>
  54. </blockquote>
  55. <blockquote>
  56. <p><tt>SampleFile</tt> </p>
  57. </blockquote>
  58. <blockquote>
  59. <blockquote>
  60. <p><tt>= REG_SZ Class for Sample Files</tt> </p>
  61. </blockquote>
  62. </blockquote>
  63. <blockquote>
  64. <blockquote>
  65. <p><tt>CLSID</tt> </p>
  66. </blockquote>
  67. </blockquote>
  68. <blockquote>
  69. <blockquote>
  70. <blockquote>
  71. <p><tt>= REG_SZ {40A45370-0386-11D0-AE19-00AA004B9986}</tt> </p>
  72. </blockquote>
  73. </blockquote>
  74. </blockquote>
  75. <blockquote>
  76. <p><tt>CLSID</tt> </p>
  77. </blockquote>
  78. <blockquote>
  79. <blockquote>
  80. <p><tt>{40A45370-0386-11D0-AE19-00AA004B9986}</tt> </p>
  81. </blockquote>
  82. </blockquote>
  83. <blockquote>
  84. <blockquote>
  85. <blockquote>
  86. <p><tt>= REG_SZ Sample Files</tt> </p>
  87. </blockquote>
  88. </blockquote>
  89. </blockquote>
  90. <blockquote>
  91. <blockquote>
  92. <blockquote>
  93. <p><tt>InprocServer32</tt> </p>
  94. </blockquote>
  95. </blockquote>
  96. </blockquote>
  97. <blockquote>
  98. <blockquote>
  99. <blockquote>
  100. <blockquote>
  101. <p><tt>= REG_SZ sample.dll</tt> </p>
  102. </blockquote>
  103. </blockquote>
  104. </blockquote>
  105. </blockquote>
  106. <blockquote>
  107. <blockquote>
  108. <blockquote>
  109. <p><b><tt>PersistentHandler</tt></b> </p>
  110. </blockquote>
  111. </blockquote>
  112. </blockquote>
  113. <blockquote>
  114. <blockquote>
  115. <blockquote>
  116. <blockquote>
  117. <p><tt>= REG_SZ {A6317C60-0386-11D0-AE19-00AA004B9986}</tt> </p>
  118. </blockquote>
  119. </blockquote>
  120. </blockquote>
  121. </blockquote>
  122. <blockquote>
  123. <blockquote>
  124. <p><tt>{A6317C60-0386-11D0-AE19-00AA004B9986}</tt> </p>
  125. </blockquote>
  126. </blockquote>
  127. <blockquote>
  128. <blockquote>
  129. <blockquote>
  130. <p><tt>= REG_SZ Sample file persistent handler</tt> </p>
  131. </blockquote>
  132. </blockquote>
  133. </blockquote>
  134. <blockquote>
  135. <blockquote>
  136. <blockquote>
  137. <p><b><tt>PersistentAddinsRegistered</tt></b> </p>
  138. </blockquote>
  139. </blockquote>
  140. </blockquote>
  141. <blockquote>
  142. <blockquote>
  143. <blockquote>
  144. <blockquote>
  145. <p><tt>{89BCB740-6119-101A-BCB7-00DD010655AF}</tt> </p>
  146. </blockquote>
  147. </blockquote>
  148. </blockquote>
  149. </blockquote>
  150. <blockquote>
  151. <blockquote>
  152. <blockquote>
  153. <blockquote>
  154. <blockquote>
  155. <p><tt>= REG_SZ
  156. {D7455400-0386-11D0-AE19-00AA004B9986}</tt> </p>
  157. </blockquote>
  158. </blockquote>
  159. </blockquote>
  160. </blockquote>
  161. </blockquote>
  162. <blockquote>
  163. <blockquote>
  164. <p><tt>{D7455400-0386-11D0-AE19-00AA004B9986}</tt> </p>
  165. </blockquote>
  166. </blockquote>
  167. <blockquote>
  168. <blockquote>
  169. <blockquote>
  170. <p><tt>= REG_SZ C and C++ filter</tt> </p>
  171. </blockquote>
  172. </blockquote>
  173. </blockquote>
  174. <blockquote>
  175. <blockquote>
  176. <blockquote>
  177. <p><tt>InprocServer32</tt> </p>
  178. </blockquote>
  179. </blockquote>
  180. </blockquote>
  181. <blockquote>
  182. <blockquote>
  183. <blockquote>
  184. <blockquote>
  185. <p><tt>= REG_SZ sampfilt.dll</tt> </p>
  186. </blockquote>
  187. </blockquote>
  188. </blockquote>
  189. </blockquote>
  190. <p>Up through the entry for the class (CLSID\40A45370-0386-11D0-AE19-00AA004B9986) this is standard OLE. The DLL
  191. sample.dll implements running object behavior for the .sam class. But note the extra entry, <b>PersistentHandler</b>. This specifies the class
  192. responsible for brokering requests to the persistent objects of the sample class. The entry under <b>PersistentAddinsRegistered</b>
  193. identifies the implementation responsible for the interface named 89BCB740-6119-101A-BCB7-00DD010655AF (IID_IFilter).
  194. Finally, we come to the class implementing IID_IFilter and again, the syntax is standard OLE. The InprocServer32 is loaded through
  195. the standard OLE mechanism. </p>
  196. <h1><a name="Pseudo-Persistent Handler API">Pseudo-Persistent Handler API</a></h1>
  197. <p>Three API are provided with Microsoft Index Server which are sufficient to instantiate IFilter for use by Microsoft Index Server. These
  198. API are <b>not</b> a full implementation of OLE persistent handlers. The three API are: </p>
  199. <p><tt>SCODE LoadIFilter( WCHAR const * pwcsPath, IUnknown * pUnkOuter, void ** ppIUnk );</tt> </p>
  200. <p><tt>SCODE BindIFilterFromStorage( IStorage * pStg, IUnknown * pUnkOuter, void ** ppIUnk );</tt> </p>
  201. <p><tt>SCODE BindIFilterFromStream( IStream * pStm, IUnknown * pUnkOuter, void ** ppIUnk );</tt> </p>
  202. <p>Each will take an object or object name (as a path, IStorage, and IStream respectively) plus an optional controlling unknown and
  203. return an interface pointer bound to the IFilter interface. The latter two API are especially useful when binding to the filter of an
  204. embedded object. </p>
  205. <p>These API are declared in the file ntquery.h, and exported from query.lib. </p>
  206. <h1><a name="Recommended Properties">Recommended Properties</a></h1>
  207. <p>The IFilter interface does not require any particular property be exposed, but Index Server will take advantage of the existence of
  208. some properties. Filter writers are encouraged to expose the following properties. Exposing the same properties from multiple object
  209. formats allows the client of Index Server to make a common query across many (or all) types of object. </p>
  210. <p>The properties below are named by the format identifier of the property set, followed by either a number corresponding to the
  211. PROPID of the PROPSPEC for properties of type PRSPEC_PROPID or a string corresponding to the string name for properties of
  212. type PRSPEC_LPWSTR. </p>
  213. <blockquote>
  214. <h2><a name="Title">Title</a></h2>
  215. <p>F29F85E0-4FF9-1068-AB91-08002B27B3D9\2 </p>
  216. <p>The title property is the title property from the Microsoft&#174; Office summary information property set. By default, this
  217. property is cached by the index server for quick retrieval. The HTML filter also exposes the title property. </p>
  218. </blockquote>
  219. <blockquote>
  220. <h2><a name="Description">Description</a></h2>
  221. <p>D1B5D3F0-C0B3-11CF-9A92-00A0C908DBF1\&#148;DESCRIPTION&#148; </p>
  222. <p>The description property is exposed by the HTML filter. <a href="#FOOTNOTE_1">[1]</a> It corresponds to the <tt>&lt;META NAME=&#148;DESCRIPTION&#148;
  223. ...&gt;</tt> tag. If this property exists, it is used exclusively to generate the document abstract. </p>
  224. <p><i>Note that other properties of type PRSPEC_LPWSTR in the same property set as the description property
  225. correspond to other HTML meta tags with the equivalent name.</i> </p>
  226. </blockquote>
  227. <blockquote>
  228. <h2><a name="Office Summary Information">Office Summary Information</a></h2>
  229. <p>F29F85E0-4FF9-1068-AB91-08002B27B3D9\2 (title) </p>
  230. <p>F29F85E0-4FF9-1068-AB91-08002B27B3D9\3 (subject) </p>
  231. <p>F29F85E0-4FF9-1068-AB91-08002B27B3D9\4 (author) </p>
  232. <p>F29F85E0-4FF9-1068-AB91-08002B27B3D9\5 (keywords) </p>
  233. <p>F29F85E0-4FF9-1068-AB91-08002B27B3D9\6 (comments) </p>
  234. <p>In addition to title, several other properties from the Microsoft&#174; Office summary information property set may be
  235. useful. Their use is listed above after the PROPID. </p>
  236. <p>&#160;</p>
  237. <p>&#160;</p>
  238. <p>&#160;</p>
  239. <p><font size=2>The information contained in this document represents the current view of Microsoft Corporation on the issues discussed as of the
  240. date of publication. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment
  241. on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information presented after the date of publication.<br>
  242. <br>
  243. This document is for informational purposes only. <strong>MICROSOFT MAKES NO WARRANTIES, EXPRESS OR IMPLIED, IN THIS
  244. DOCUMENT.</strong><br>
  245. <br>
  246. &#169; 1996 Microsoft Corporation. All rights reserved.<br>
  247. <br>
  248. Microsoft is a registered trademark of Microsoft Corporation. Other product and company names herein may be the trademarks of
  249. their respective owners.</font></p>
  250. </blockquote>
  251. <hr>
  252. <h4>Footnotes</h4>
  253. <p><a name="FOOTNOTE_1">[1]</a> Meta descriptions are not emitted by the sample HTML filter. </p>
  254. </body>
  256. </html>