PageRenderTime 58ms CodeModel.GetById 22ms RepoModel.GetById 1ms app.codeStats 0ms

/Releases/1.0 Release 1/WildCardSearch/bin/Debug/Microsoft.Office.Server.Search.xml

#
XML | 3379 lines | 3379 code | 0 blank | 0 comment | 0 complexity | 8863efb4fddfa170c6fcff09e5f5563c MD5 | raw file

Large files files are truncated, but you can click here to view the full file

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Office.Server.Search</name>
  5. </assembly>
  6. <members>
  7. <member name="N:Microsoft.Office.Server.Search.Administration">
  8. <summary>Provides administrative types and members for managing a Shared Service Provider's instance of Enterprise Search. </summary>
  9. </member>
  10. <member name="T:Microsoft.Office.Server.Search.Administration.AllContentScopeRule">
  11. <summary>Represents a scope rule that includes all items in the content index.</summary>
  12. </member>
  13. <member name="P:Microsoft.Office.Server.Search.Administration.AllContentScopeRule.Count">
  14. <summary>Gets the number of items in the content index that match the scope rule.</summary>
  15. <returns>A 32-bit integer representing the number of content items that match the scope rule.</returns>
  16. </member>
  17. <member name="P:Microsoft.Office.Server.Search.Administration.AllContentScopeRule.FilterBehavior">
  18. <summary>Gets the behavior of the scope rule filter.</summary>
  19. <returns>A value from the <see cref="T:Microsoft.Office.Server.Search.Administration.ScopeRuleFilterBehavior"></see> enumeration specifying the filter behavior for the scope rule.</returns>
  20. </member>
  21. <member name="T:Microsoft.Office.Server.Search.Administration.AuthorityPage">
  22. <summary>Represents an authoritative page for Enterprise Search. </summary>
  23. </member>
  24. <member name="M:Microsoft.Office.Server.Search.Administration.AuthorityPage.Delete">
  25. <summary>Deletes the authoritative page.</summary>
  26. </member>
  27. <member name="P:Microsoft.Office.Server.Search.Administration.AuthorityPage.Level">
  28. <summary>Gets or sets the authority level setting for an authoritative page.</summary>
  29. <returns>A floating-point number that specifies the level value. Must be 0, 1, or 2.</returns>
  30. </member>
  31. <member name="P:Microsoft.Office.Server.Search.Administration.AuthorityPage.Status">
  32. <summary>Gets information about the status of an authoritative page.</summary>
  33. <returns>A value from the <see cref="T:Microsoft.Office.Server.Search.Administration.AuthorityPageStatus"></see> enumeration describing the status of the authoritative page.</returns>
  34. </member>
  35. <member name="P:Microsoft.Office.Server.Search.Administration.AuthorityPage.Url">
  36. <summary>Gets the URL for an authoritative page.</summary>
  37. <returns>A System.Uri object representing the URL of the authoritative page.</returns>
  38. </member>
  39. <member name="T:Microsoft.Office.Server.Search.Administration.AuthorityPageCollection">
  40. <summary>Represents a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.AuthorityPage"></see> objects.</summary>
  41. </member>
  42. <member name="M:Microsoft.Office.Server.Search.Administration.AuthorityPageCollection.Create(System.Uri,System.Single)">
  43. <summary>Creates an authoritative page.</summary>
  44. <returns>An <see cref="T:Microsoft.Office.Server.Search.Administration.AuthorityPage"></see> object.</returns>
  45. <param name="url">A System.Uri object representing the URL of the authoritative page.</param>
  46. <param name="level">A floating-point number specifying the level value for the authoritative page. Must be 0, 1, or 2. </param>
  47. </member>
  48. <member name="M:Microsoft.Office.Server.Search.Administration.AuthorityPageCollection.GetEnumerator">
  49. <summary>Returns an enumerator that iterates through the authoritative pages in the collection.</summary>
  50. <returns>An IEnumerator object that can be used to iterate through the collection.</returns>
  51. </member>
  52. <member name="M:Microsoft.Office.Server.Search.Administration.AuthorityPageCollection.Refresh">
  53. <summary>Refreshes the collection of authoritative pages.</summary>
  54. </member>
  55. <member name="P:Microsoft.Office.Server.Search.Administration.AuthorityPageCollection.Count">
  56. <summary>Gets the number of <see cref="T:Microsoft.Office.Server.Search.Administration.AuthorityPage"></see> objects in the collection.</summary>
  57. <returns>A 32-bit integer containing the number of AuthorityPage objects in the collection.</returns>
  58. </member>
  59. <member name="P:Microsoft.Office.Server.Search.Administration.AuthorityPageCollection.Item(System.Int32)">
  60. <summary>Gets the authoritative page at the specified index in the collection.</summary>
  61. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.AuthorityPage"></see> object.</returns>
  62. <param name="index">A 32-bit integer that specifies the position in the index.</param>
  63. </member>
  64. <member name="P:Microsoft.Office.Server.Search.Administration.AuthorityPageCollection.Item(System.Uri)">
  65. <summary>Gets the authoritative page from the collection based on the specified URL.</summary>
  66. <returns>An <see cref="T:Microsoft.Office.Server.Search.Administration.AuthorityPage"></see> object.</returns>
  67. <param name="url">A System.Uri object representing the URL.</param>
  68. </member>
  69. <member name="T:Microsoft.Office.Server.Search.Administration.AuthorityPageStatus">
  70. <summary>Defines the authority page status values for the <see cref="P:Microsoft.Office.Server.Search.Administration.AuthorityPage.Status"></see> property of the <see cref="T:Microsoft.Office.Server.Search.Administration.AuthorityPage"></see> class. </summary>
  71. </member>
  72. <member name="F:Microsoft.Office.Server.Search.Administration.AuthorityPageStatus.CrawledSuccessfully">
  73. <summary>The authoritative page was crawled successfully.</summary>
  74. </member>
  75. <member name="F:Microsoft.Office.Server.Search.Administration.AuthorityPageStatus.CrawledWithErrors">
  76. <summary>The authoritative page was crawled, but with errors.</summary>
  77. </member>
  78. <member name="F:Microsoft.Office.Server.Search.Administration.AuthorityPageStatus.NotCrawled">
  79. <summary>The authoritative page has not been crawled.</summary>
  80. </member>
  81. <member name="F:Microsoft.Office.Server.Search.Administration.AuthorityPageStatus.StatusNotInitialized">
  82. <summary>The authoritative page has not been initialized.</summary>
  83. </member>
  84. <member name="T:Microsoft.Office.Server.Search.Administration.BestBet">
  85. <summary>Represents a best bet in the Enterprise Search keyword and best bet management system.</summary>
  86. </member>
  87. <member name="M:Microsoft.Office.Server.Search.Administration.BestBet.Update">
  88. <summary>Updates a best bet with the specified changes.</summary>
  89. </member>
  90. <member name="P:Microsoft.Office.Server.Search.Administration.BestBet.Description">
  91. <summary>Gets or sets the text description for a best bet.</summary>
  92. <returns>A string that contains the description.</returns>
  93. </member>
  94. <member name="P:Microsoft.Office.Server.Search.Administration.BestBet.ParentKeywords">
  95. <summary>Gets the collection of parent keywords associated with the best bet.</summary>
  96. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.KeywordCollection"></see> object representing a collection of keywords.</returns>
  97. </member>
  98. <member name="P:Microsoft.Office.Server.Search.Administration.BestBet.Title">
  99. <summary>Gets or sets the title for a best bet.</summary>
  100. <returns>A string that contains the best bet title.</returns>
  101. </member>
  102. <member name="P:Microsoft.Office.Server.Search.Administration.BestBet.Url">
  103. <summary>Gets or sets the URL for the best bet.</summary>
  104. <returns>A System.Uri object representing the best bet's URL.</returns>
  105. </member>
  106. <member name="T:Microsoft.Office.Server.Search.Administration.BestBetCollection">
  107. <summary>Represents a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> objects.</summary>
  108. </member>
  109. <member name="M:Microsoft.Office.Server.Search.Administration.BestBetCollection.Create(System.String,System.String,System.Uri)">
  110. <summary>Creates a new best bet.</summary>
  111. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> object.</returns>
  112. <param name="t itle">A string specifying the best bet's title.</param>
  113. <param name="description">A string specifying the description for the best bet.</param>
  114. <param name="url">A System.Uri object representing the URL.</param>
  115. </member>
  116. <member name="M:Microsoft.Office.Server.Search.Administration.BestBetCollection.GetEnumerator">
  117. <summary>Returns an enumerator that can be used to access the items in the best bet collection.</summary>
  118. <returns>A System.Collections.IEnumerator object.</returns>
  119. </member>
  120. <member name="M:Microsoft.Office.Server.Search.Administration.BestBetCollection.Remove(Microsoft.Office.Server.Search.Administration.BestBet)">
  121. <summary>Removes the association between a specified best bet and the keyword parent for this collection of best bets.</summary>
  122. <param name="bestBet">A <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> object.</param>
  123. </member>
  124. <member name="M:Microsoft.Office.Server.Search.Administration.BestBetCollection.SetPosition(Microsoft.Office.Server.Search.Administration.BestBet,System.Int32)">
  125. <summary>Updates the priority for a specified best bet.</summary>
  126. <param name="bb">A <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> object representing the best bet to update.</param>
  127. <param name="position">A 32-bit integer that specifies a new position for the specified best bet.</param>
  128. </member>
  129. <member name="P:Microsoft.Office.Server.Search.Administration.BestBetCollection.Count">
  130. <summary>Gets the number of <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> objects in the collection.</summary>
  131. <returns>A 32-bit integer representing the number of best bets in the collection.</returns>
  132. </member>
  133. <member name="P:Microsoft.Office.Server.Search.Administration.BestBetCollection.Item(System.Uri)">
  134. <summary>Gets the specified best bet from the collection based on the specified URL.</summary>
  135. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> object representing the specified best bet.</returns>
  136. <param name="url">A System.Uri object representing the URL.</param>
  137. </member>
  138. <member name="T:Microsoft.Office.Server.Search.Administration.BestBetFilter">
  139. <summary>Defines the filter types available for the <see cref="M:Microsoft.Office.Server.Search.Administration.Keywords.GetFilteredBestBets"></see> method of the <see cref="T:Microsoft.Office.Server.Search.Administration.Keywords"></see> class.</summary>
  140. </member>
  141. <member name="F:Microsoft.Office.Server.Search.Administration.BestBetFilter.BestBetTitle">
  142. <summary>Specifies filter for the best bet title.</summary>
  143. </member>
  144. <member name="F:Microsoft.Office.Server.Search.Administration.BestBetFilter.BestBetUrl">
  145. <summary>Specifies filter for the best bet URL.</summary>
  146. </member>
  147. <member name="F:Microsoft.Office.Server.Search.Administration.BestBetFilter.Both">
  148. <summary>Specifies filter for both the best bet title and URL.</summary>
  149. </member>
  150. <member name="F:Microsoft.Office.Server.Search.Administration.BestBetFilter.None">
  151. <summary>No filter specified.</summary>
  152. </member>
  153. <member name="T:Microsoft.Office.Server.Search.Administration.BestBetsEnumerator">
  154. <summary>Supports iterating over a <see cref="T:Microsoft.Office.Server.Search.Administration.BestBetCollection"></see> and reading its individual <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> objects.</summary>
  155. </member>
  156. <member name="M:Microsoft.Office.Server.Search.Administration.BestBetsEnumerator.#ctor(Microsoft.Office.Server.Search.Administration.BestBetCollection)">
  157. <summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Server.Search.Administration.BestBetsEnumerator"></see> class.</summary>
  158. <param name="bestBets">The <see cref="T:Microsoft.Office.Server.Search.Administration.BestBetCollection"></see> through which to iterate.</param>
  159. </member>
  160. <member name="M:Microsoft.Office.Server.Search.Administration.BestBetsEnumerator.MoveNext">
  161. <summary>Advances the enumerator to the next element of the collection.</summary>
  162. <returns>true if the enumerator was successfully advanced to the next element; otherwise, false if the enumerator has passed the end of the collection.</returns>
  163. </member>
  164. <member name="M:Microsoft.Office.Server.Search.Administration.BestBetsEnumerator.Reset">
  165. <summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
  166. </member>
  167. <member name="P:Microsoft.Office.Server.Search.Administration.BestBetsEnumerator.Current">
  168. <summary>Gets the current element in the collection.</summary>
  169. <returns>The current <see cref="T:Microsoft.Office.Server.Search.Administration.BestBet"></see> in the collection.</returns>
  170. </member>
  171. <member name="T:Microsoft.Office.Server.Search.Administration.BusinessDataContentSource">
  172. <summary>Represents a content source for Business Data Catalog content. </summary>
  173. </member>
  174. <member name="M:Microsoft.Office.Server.Search.Administration.BusinessDataContentSource.ConstructStartAddress(System.String,System.String)">
  175. <summary>Returns the start address for a business data content source.</summary>
  176. <returns>A System.Uri object that represents the start address for the <see cref="T:Microsoft.Office.Server.Search.Administration.BusinessDataContentSource"></see> object.</returns>
  177. <param name="bdcAppName">A string containing the name of the application in the Business Data Catalog.</param>
  178. <param name="searchAppName">A string containing the search application name.</param>
  179. </member>
  180. <member name="M:Microsoft.Office.Server.Search.Administration.BusinessDataContentSource.ParseStartAddress(System.Uri,System.String@,System.String@)">
  181. <summary>Parses the start address for a business data content source.</summary>
  182. <param name="startAddress">A System.Uri object that represents the start address for the <see cref="T:Microsoft.Office.Server.Search.Administration.BusinessDataContentSource"></see> object.</param>
  183. <param name="bdcAppName">A string containing the application name of the Business Data Catalog.</param>
  184. <param name="searchAppName">A string containing the search application name.</param>
  185. </member>
  186. <member name="M:Microsoft.Office.Server.Search.Administration.BusinessDataContentSource.Update">
  187. <summary>Updates a business data content source with the specified changes.</summary>
  188. </member>
  189. <member name="T:Microsoft.Office.Server.Search.Administration.CatalogType">
  190. <summary>Defines the catalog types for the <see cref="M:Microsoft.Office.Server.Search.Administration.CrawlLogFilters.AddFilter"></see> method of the <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlLogFilters"></see> class.</summary>
  191. </member>
  192. <member name="T:Microsoft.Office.Server.Search.Administration.CategoriesEnumerator">
  193. <summary>Supports iterating over a <see cref="T:Microsoft.Office.Server.Search.Administration.CategoryCollection"></see> object and reading its individual <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> objects.</summary>
  194. </member>
  195. <member name="M:Microsoft.Office.Server.Search.Administration.CategoriesEnumerator.#ctor(Microsoft.Office.Server.Search.Administration.CategoryCollection)">
  196. <summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Server.Search.Administration.CategoriesEnumerator"></see> class.</summary>
  197. <param name="categories">The <see cref="T:Microsoft.Office.Server.Search.Administration.CategoryCollection"></see> object through which to iterate.</param>
  198. </member>
  199. <member name="M:Microsoft.Office.Server.Search.Administration.CategoriesEnumerator.MoveNext">
  200. <summary>Advances the enumerator to the next element of the collection.</summary>
  201. <returns>true if the enumerator was successfully advanced to the next element; otherwise, false if the enumerator has passed to the end of the collection.</returns>
  202. </member>
  203. <member name="M:Microsoft.Office.Server.Search.Administration.CategoriesEnumerator.Reset">
  204. <summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
  205. </member>
  206. <member name="P:Microsoft.Office.Server.Search.Administration.CategoriesEnumerator.Current">
  207. <summary>Gets the current element in the collection.</summary>
  208. <returns>The current <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> object in the collection.</returns>
  209. </member>
  210. <member name="T:Microsoft.Office.Server.Search.Administration.Category">
  211. <summary>Represents a category in the Enterprise Search metadata property schema.</summary>
  212. </member>
  213. <member name="M:Microsoft.Office.Server.Search.Administration.Category.Contains(System.Guid)">
  214. <summary>Returns a Boolean value that indicates whether the category contains any crawled properties for the specified property set.</summary>
  215. <returns>true if the category contains crawled properties matching the specified property set; otherwise, false.</returns>
  216. <param name="propset">A GUID that identifies the property set.</param>
  217. </member>
  218. <member name="M:Microsoft.Office.Server.Search.Administration.Category.CreateCrawledProperty(System.String,System.Boolean,System.Guid,System.Int32)">
  219. <summary>Creates a crawled property for the category.</summary>
  220. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.CrawledProperty"></see> object representing the crawled property that was created.</returns>
  221. <param name="variantType">A 32-bit integer that specifies the variant data type of the crawled property.</param>
  222. <param name="propertyName">A string that specifies the name for the crawled property.</param>
  223. <param name="isNameEnum">A Boolean value that specifies whether the crawled property name is enumerable.</param>
  224. <param name="propset">A GUID that specifies the property set for the crawled property.</param>
  225. </member>
  226. <member name="M:Microsoft.Office.Server.Search.Administration.Category.CreateOrGetCrawledProperty(System.String,System.Boolean,System.Guid,System.Int32)">
  227. <summary>Creates or returns a crawled property for a category.</summary>
  228. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.CrawledProperty"></see> object representing the crawled property created or returned for the category.</returns>
  229. <param name="variantType">A 32-bit integer that specifies the variant data type of the crawled property.</param>
  230. <param name="propertyName">A string that specifies the name for the crawled property.</param>
  231. <param name="isNameEnum">A Boolean value that specifies whether the crawled property name is enumerable.</param>
  232. <param name="propset">A GUID that specifies the property set for the crawled property.</param>
  233. </member>
  234. <member name="M:Microsoft.Office.Server.Search.Administration.Category.Delete">
  235. <summary>Deletes the category in the search schema. </summary>
  236. </member>
  237. <member name="M:Microsoft.Office.Server.Search.Administration.Category.DeleteUnmappedProperties">
  238. <summary>Deletes all crawled properties that are not mapped to managed properties for a category.</summary>
  239. </member>
  240. <member name="M:Microsoft.Office.Server.Search.Administration.Category.GetAllCrawledProperties">
  241. <summary>Returns an enumerator that iterates through the category's crawled properties.</summary>
  242. <returns>An IEnumerator object that can be used to iterate through the collection.</returns>
  243. </member>
  244. <member name="M:Microsoft.Office.Server.Search.Administration.Category.GetCrawledProperty(System.Guid,System.String,System.Int32)">
  245. <summary>Returns a crawled property for the category. </summary>
  246. <returns>A <see cref="Microsoft.Office.Server.Search.Administration.CrawledProperty"></see> object that represents the crawled property. </returns>
  247. <param name="variantType">A 32-bit integer that specifies the variant data type.</param>
  248. <param name="categoryName">A string that specifies the name of the crawled property category.</param>
  249. <param name="propset">A GUID that specifies the property set for the crawled property.</param>
  250. </member>
  251. <member name="M:Microsoft.Office.Server.Search.Administration.Category.GetUnmappedCrawledProperties">
  252. <summary>Returns an enumerator that iterates through the category's unmapped crawled properties.</summary>
  253. <returns>An IEnumerator object that can be used to iterate through the collection.</returns>
  254. </member>
  255. <member name="M:Microsoft.Office.Server.Search.Administration.Category.QueryCrawledProperties(System.String,System.Int32,System.Guid,System.String,System.Boolean)">
  256. <summary>Returns an enumerator that iterates through the category's crawled properties that match the specified parameters.</summary>
  257. <returns>An IEnumerator object that can be used to iterate through the collection.</returns>
  258. <param name="filter">A string that specifies the filter for the crawled properties.</param>
  259. <param name="forwardDirection">A Boolean value that specifies the direction of the query. </param>
  260. <param name="lastPropertyName">A string that specifies that last specified crawled property name.</param>
  261. <param name="maxProperties">A 32-bit integer that specifies the maximum number of crawled properties to return.</param>
  262. <param name="lastPropset">A GUID that identifies the last specified property set.</param>
  263. </member>
  264. <member name="M:Microsoft.Office.Server.Search.Administration.Category.Update">
  265. <summary>Updates the Shared Service Provider's search schema with changes made to the category.</summary>
  266. </member>
  267. <member name="P:Microsoft.Office.Server.Search.Administration.Category.AutoCreateNewManagedProperties">
  268. <summary>Gets or sets a Boolean value indicating whether new managed properties should be automatically created for the crawled properties in a category.</summary>
  269. <returns>true if managed properties should be automatically created; otherwise, false.</returns>
  270. </member>
  271. <member name="P:Microsoft.Office.Server.Search.Administration.Category.CrawledPropertyCount">
  272. <summary>Gets the number of crawled properties for a category.</summary>
  273. <returns>A 32-bit integer that represents the number of crawled properties for the category.</returns>
  274. </member>
  275. <member name="P:Microsoft.Office.Server.Search.Administration.Category.DiscoverNewProperties">
  276. <summary>Gets or sets a Boolean value that specifies whether the crawler should automatically discover crawled properties with every crawl. </summary>
  277. <returns>true if crawled properties should be discovered with every crawl; otherwise, false.</returns>
  278. </member>
  279. <member name="P:Microsoft.Office.Server.Search.Administration.Category.MapToContents">
  280. <summary>Gets or sets a Boolean value indicating whether all string crawled properties are mapped to content.</summary>
  281. <returns>true if string crawled properties are mapped to content; otherwise, false.</returns>
  282. </member>
  283. <member name="P:Microsoft.Office.Server.Search.Administration.Category.Name">
  284. <summary>Gets or sets the name of a category.</summary>
  285. <returns>A string specifying the name for the category.</returns>
  286. </member>
  287. <member name="T:Microsoft.Office.Server.Search.Administration.CategoryCollection">
  288. <summary>Represents a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> objects.</summary>
  289. </member>
  290. <member name="M:Microsoft.Office.Server.Search.Administration.CategoryCollection.Contains(System.Guid)">
  291. <summary>Returns a Boolean value that indicates whether the collection of categories contains the <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> object with the specified property set.</summary>
  292. <returns>true indicates the <see cref="T:Microsoft.Office.Server.Search.Administration.CategoryCollection"></see> class contains the specified <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see>; otherwise, false.</returns>
  293. <param name="propset">A GUID identifying the property set.</param>
  294. </member>
  295. <member name="M:Microsoft.Office.Server.Search.Administration.CategoryCollection.Contains(System.String)">
  296. <summary>Returns a Boolean value that indicates whether the collection of categories contains the <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> object with the specified name.</summary>
  297. <returns>true indicates the <see cref="T:Microsoft.Office.Server.Search.Administration.CategoryCollection"></see> class contains the specified <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see>; otherwise, false.</returns>
  298. <param name="name">A string specifying the name of the category.</param>
  299. </member>
  300. <member name="M:Microsoft.Office.Server.Search.Administration.CategoryCollection.Create(System.String,System.Guid)">
  301. <summary>Adds a new category to the category collection.</summary>
  302. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> object that represents the category.</returns>
  303. <param name="name">A string that specifies the name for the category.</param>
  304. <param name="propset">A GUID that identifies the category's property set.</param>
  305. </member>
  306. <member name="M:Microsoft.Office.Server.Search.Administration.CategoryCollection.GetEnumerator">
  307. <summary>Returns an enumerator that iterates through the categories in the collection.</summary>
  308. <returns>An IEnumerator object that can be used to iterate through the collection.</returns>
  309. </member>
  310. <member name="P:Microsoft.Office.Server.Search.Administration.CategoryCollection.Count">
  311. <summary>Gets the number of <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> objects in the collection.</summary>
  312. <returns>A 32-bit integer containing the number of <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> objects in the collection.</returns>
  313. </member>
  314. <member name="P:Microsoft.Office.Server.Search.Administration.CategoryCollection.Item(System.Guid)">
  315. <summary>Gets the category with the specified GUID from the collection of categories.</summary>
  316. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> object that represents a category.</returns>
  317. <param name="propset">A GUID identifying the property set.</param>
  318. </member>
  319. <member name="P:Microsoft.Office.Server.Search.Administration.CategoryCollection.Item(System.String)">
  320. <summary>Gets the category with the specified name from the collection of categories.</summary>
  321. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.Category"></see> object that represents the category.</returns>
  322. <param name="Name">A string that specifies the category name.</param>
  323. </member>
  324. <member name="T:Microsoft.Office.Server.Search.Administration.Content">
  325. <summary>Represents the top-level object for administration of the content sources for a Shared Services Provider's (SSP) search service.</summary>
  326. </member>
  327. <member name="M:Microsoft.Office.Server.Search.Administration.Content.#ctor(Microsoft.Office.Server.Search.Administration.SearchContext)">
  328. <summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Server.Search.Administration.Content"></see> class.</summary>
  329. <param name="parent">A <see cref="T:Microsoft.Office.Server.Search.Administration.SearchContext"></see> object representing a Shared Services Provider's search service.</param>
  330. </member>
  331. <member name="M:Microsoft.Office.Server.Search.Administration.Content.DeleteCrawlInProgress">
  332. <summary>Returns a Boolean value indicating whether a crawl in progress can be deleted. </summary>
  333. <returns>true if a delete crawl is in progress; otherwise, false.</returns>
  334. </member>
  335. <member name="M:Microsoft.Office.Server.Search.Administration.Content.ListKnownLotusNotesDatabases(System.String)">
  336. <summary>Returns the list of Lotus Notes databases for a specified server.</summary>
  337. <returns>A string array that contains the database name for each Lotus Notes database.</returns>
  338. <param name="serverName">A string containing the name of a Lotus Notes server.</param>
  339. </member>
  340. <member name="M:Microsoft.Office.Server.Search.Administration.Content.PauseBackgroundActivity">
  341. <summary>Pauses all content-related activity for a Shared Services Provider's search service.</summary>
  342. </member>
  343. <member name="M:Microsoft.Office.Server.Search.Administration.Content.ResumeBackgroundActivity">
  344. <summary>Resumes content-related activity for a Shared Services Provider's search service.</summary>
  345. </member>
  346. <member name="M:Microsoft.Office.Server.Search.Administration.Content.SetDefaultGatheringAccount(System.String,System.Security.SecureString)">
  347. <summary>Sets the default crawler account and password. </summary>
  348. <param name="account">A string that contains the name of the crawler account.</param>
  349. <param name="password">A string that contains the password for the crawler account.</param>
  350. </member>
  351. <member name="P:Microsoft.Office.Server.Search.Administration.Content.ActiveDocuments">
  352. <summary>Gets an array of active documents for a Shared Services Provider.</summary>
  353. <returns>A string array containing the active documents.</returns>
  354. </member>
  355. <member name="P:Microsoft.Office.Server.Search.Administration.Content.ClientCertificateNames">
  356. <summary>Gets a list of all the client certificates available to the crawler to use for the crawl rules.</summary>
  357. <returns>A string array that contains the client certificate names.</returns>
  358. </member>
  359. <member name="P:Microsoft.Office.Server.Search.Administration.Content.ContentSources">
  360. <summary>Gets the collection of content sources for the Shared Services Provider's search service.</summary>
  361. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSourceCollection"></see> object containing a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> objects that represent content sources.</returns>
  362. </member>
  363. <member name="P:Microsoft.Office.Server.Search.Administration.Content.CrawlMappings">
  364. <summary>Gets the collection of crawl mappings for a Shared Services Provider's search service.</summary>
  365. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlMappingCollection"></see> object containing a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlMapping"></see> objects that represent crawl mappings.</returns>
  366. </member>
  367. <member name="P:Microsoft.Office.Server.Search.Administration.Content.CrawlRules">
  368. <summary>Gets the collection of crawl rules for a Shared Services Provider's search service.</summary>
  369. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlRuleCollection"></see> object containing a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlRule"></see> objects representing crawl rules.</returns>
  370. </member>
  371. <member name="P:Microsoft.Office.Server.Search.Administration.Content.DefaultGatheringAccount">
  372. <summary>Gets the default account used by the crawler.</summary>
  373. <returns>A string that contains the account name.</returns>
  374. </member>
  375. <member name="P:Microsoft.Office.Server.Search.Administration.Content.ExtensionList">
  376. <summary>Gets the list of file name extensions.</summary>
  377. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.ExtensionCollection"></see> object containing a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.Extension"></see> objects that represent file name extensions.</returns>
  378. </member>
  379. <member name="P:Microsoft.Office.Server.Search.Administration.Content.ListKnownLotusNotesServers">
  380. <summary>Gets the list of Lotus Notes servers that are known to the Shared Services Provider's search service.</summary>
  381. <returns>A string array containing the names of Lotus Notes servers.</returns>
  382. </member>
  383. <member name="P:Microsoft.Office.Server.Search.Administration.Content.LotusNotesConfigured">
  384. <summary>Gets a Boolean value indicating whether the search service is configured to crawl Lotus Notes content.</summary>
  385. <returns>true if the search service is configured to crawl Lotus Notes content; otherwise, false. </returns>
  386. </member>
  387. <member name="P:Microsoft.Office.Server.Search.Administration.Content.Parent">
  388. <summary>Gets the search context for the Shared Services Provider's search service. </summary>
  389. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.SearchContext"></see> object representing the search service.</returns>
  390. </member>
  391. <member name="P:Microsoft.Office.Server.Search.Administration.Content.RetryLimit">
  392. <summary>Gets or sets the time-out value.</summary>
  393. <returns>A 32-bit integer representing the time-out value.</returns>
  394. </member>
  395. <member name="T:Microsoft.Office.Server.Search.Administration.ContentSource">
  396. <summary>Provides the base class for all Enterprise Search content sources.</summary>
  397. </member>
  398. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.#ctor(Microsoft.Office.Server.Search.Administration.ContentSourceCollection,System.String)">
  399. <summary>This member is reserved for internal use and is not intended to be used directly from your code. Initializes a new instance of the <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> class. Do not use this method to create a content source, instead use the <see cref="M:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Create"></see> method of the <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSourceCollection"></see> class.</summary>
  400. <param name="name">This member is reserved for internal use and is not intended to be used directly from your code.</param>
  401. <param name="parent">This member is reserved for internal use and is not intended to be used directly from your code.</param>
  402. </member>
  403. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.Delete">
  404. <summary>Deletes the content source.</summary>
  405. </member>
  406. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.PauseCrawl">
  407. <summary>Pauses an active crawl for the content source.</summary>
  408. </member>
  409. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.ResumeCrawl">
  410. <summary>Resumes a paused crawl for the content source.</summary>
  411. </member>
  412. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.StartFullCrawl">
  413. <summary>Starts a full crawl of the content source.</summary>
  414. </member>
  415. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.StartIncrementalCrawl">
  416. <summary>Starts an incremental crawl of the content source.</summary>
  417. </member>
  418. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.StopCrawl">
  419. <summary>Stops the crawl of a content source.</summary>
  420. </member>
  421. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSource.Update">
  422. <summary>Updates a content source with the specified changes.</summary>
  423. </member>
  424. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.CrawlCompleted">
  425. <summary>Gets the time of the last completed crawl of a content source.</summary>
  426. <returns>A System.DateTime object that represents the date and time value of the completed last crawl.</returns>
  427. </member>
  428. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.CrawlStarted">
  429. <summary>Gets the start time of the last crawl.</summary>
  430. <returns>A System.DateTime object that represents the start date and time value of the last completed crawl.</returns>
  431. </member>
  432. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.CrawlStatus">
  433. <summary>Gets information about a content source's crawl status.</summary>
  434. <returns>A value from the <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlStatus"></see> enumeration describing the content source's crawl status.</returns>
  435. </member>
  436. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.FullCrawlSchedule">
  437. <summary>Gets or sets a content source's schedule of full crawls.</summary>
  438. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.Schedule"></see> object representing the full crawl schedule for the content source.</returns>
  439. </member>
  440. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.Id">
  441. <summary>Gets the identifier for a content source.</summary>
  442. <returns>A 32-bit integer that identifies the content source.</returns>
  443. </member>
  444. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.IncrementalCrawlSchedule">
  445. <summary>Gets or sets a content source's schedule of incremental crawls.</summary>
  446. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.Schedule"></see> object representing the incremental crawl schedule for the content source.</returns>
  447. </member>
  448. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.Name">
  449. <summary>Gets or sets the name for the content source.</summary>
  450. <returns>A string that contains the name.</returns>
  451. </member>
  452. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.Parent">
  453. <summary>Gets the content source collection containing the content source.</summary>
  454. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSourceCollection"></see> object representing the collection of <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> objects containing the content source.</returns>
  455. </member>
  456. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.StartAddresses">
  457. <summary>Gets the collection of start addresses for a content source.</summary>
  458. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.StartAddressCollection"></see> object that represents the start addresses for the content source.</returns>
  459. </member>
  460. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSource.Tag">
  461. <summary>Gets or sets the URL for the page to modify the settings for a custom content source.</summary>
  462. <returns>A string containing the URL.</returns>
  463. </member>
  464. <member name="T:Microsoft.Office.Server.Search.Administration.ContentSourceCollection">
  465. <summary>Represents a collection of <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> objects.</summary>
  466. </member>
  467. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Create(System.Type,System.String)">
  468. <summary>Creates a new content source in the collection.</summary>
  469. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> object.</returns>
  470. <param name="type">The object type of the content source.</param>
  471. <param name="name">A string containing the content source name.</param>
  472. </member>
  473. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Exists(System.Int32)">
  474. <summary>Returns a Boolean value that indicates whether the specified content source exists in the collection.</summary>
  475. <returns>true if the content source exists; otherwise, false.</returns>
  476. <param name="id">A 32-bit integer that specifies the content source ID.</param>
  477. </member>
  478. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Exists(System.String)">
  479. <summary>Returns a Boolean value that indicates whether the specified content source exists in the collection.</summary>
  480. <returns>true if the content source exists; otherwise, false.</returns>
  481. <param name="name">A string that contains the name of the content source.</param>
  482. </member>
  483. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.GetEnumerator">
  484. <summary>Returns an enumerator that iterates through the content sources in the collection.</summary>
  485. <returns>An IEnumerator object that can be used to iterate through the collection.</returns>
  486. </member>
  487. <member name="M:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Update">
  488. <summary>Updates a content source collection with the specified changes.</summary>
  489. </member>
  490. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Capacity">
  491. <summary>Gets the maximum number of content sources allowed.</summary>
  492. <returns>A 32-bit integer representing the maximum number of content sources.</returns>
  493. </member>
  494. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Count">
  495. <summary>Gets the number of <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> objects in the collection.</summary>
  496. <returns>A 32-bit integer representing the number of content sources in the collection.</returns>
  497. </member>
  498. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Item(System.Int32)">
  499. <summary>Gets the specified content source from the collection of content sources based on the specified content source ID.</summary>
  500. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> object representing a content source.</returns>
  501. <param name="id">A 32-bit integer identifying the content source.</param>
  502. </member>
  503. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Item(System.String)">
  504. <summary>Gets the specified content source from the collection of content sources based on the content source name that is specified.</summary>
  505. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.ContentSource"></see> object representing a content source.</returns>
  506. <param name="name">A string containing the content source name.</param>
  507. </member>
  508. <member name="P:Microsoft.Office.Server.Search.Administration.ContentSourceCollection.Parent">
  509. <summary>Gets the parent <see cref="T:Microsoft.Office.Server.Search.Administration.Content"></see> object for the content source collection.</summary>
  510. <returns>A <see cref="T:Microsoft.Office.Server.Search.Administration.Content"></see> object that represents the parent of the content source collection.</returns>
  511. </member>
  512. <member name="T:Microsoft.Office.Server.Search.Administration.CrawledProperty">
  513. <summary>Represents a crawled property in the Enterprise Search metadata property schema.</summary>
  514. </member>
  515. <member name="M:Microsoft.Office.Server.Search.Administration.CrawledProperty.GetMappedManagedProperties">
  516. <summary>Returns an enumerator that can iterate through a <see cref="T:Microsoft.Office.Server.Search.Administration.ManagedPropertyCollection"></see> object. </summary>
  517. <returns>An enumerator that can be used to iterate through the collection.</returns>
  518. </member>
  519. <member name="M:Microsoft.Office.Server.Search.Administration.CrawledProperty.GetSamples(System.Int32)">
  520. <summary>Returns an enumerator that supports iterating through a collection of crawled property samples.</summary>
  521. <returns>A System.Collections.IEnumerator object.</returns>
  522. <param name="sampleCount">An integer that specifies the number of samples to return.</param>
  523. </member>
  524. <member name="M:Microsoft.Office.Server.Search.Administration.CrawledProperty.ToString">
  525. <summary>Returns a string that represents the <see cref="T:Microsoft.Office.Server.Search.Administration.CrawledProperty"></see> object.</summary>
  526. <returns>A string that represents the object instance. </returns>
  527. </member>
  528. <member name="M:Microsoft.Office.Server.Search.Administration.CrawledProperty.Update">
  529. <summary>Updates the Shared Service Provider's search schema with changes made to the crawled property.</summary>
  530. </member>
  531. <member name="P:Microsoft.Office.Server.Search.Administration.CrawledProperty.CategoryName">
  532. <summary>Gets the category name for a crawled property.</summary>
  533. <returns>A string that contains the category name.</returns>
  534. </member>
  535. <member name="P:Microsoft.Office.Server.Search.Administration.CrawledProperty.IsMappedToContents">
  536. <summary>Gets or sets a Boolean value indicating whether the crawled property is mapped to any managed properties.</summary>
  537. <returns>true if the crawled property is mapped to any managed property; otherwise, false.</returns>
  538. </member>
  539. <member name="P:Microsoft.Office.Server.Search.Administration.CrawledProperty.Name">
  540. <summary>Gets the name of a crawled property.</summary>
  541. <returns>A string containing the name for the crawled property.</returns>
  542. </member>
  543. <member name="P:Microsoft.Office.Server.Search.Administration.CrawledProperty.Propset">
  544. <summary>Gets the property set of a crawled property.</summary>
  545. <returns>A GUID that identifies the property set for the crawled property.</returns>
  546. </member>
  547. <member name="P:Microsoft.Office.Server.Search.Administration.CrawledProperty.VariantType">
  548. <summary>Gets the variant data type for a crawled property.</summary>
  549. <returns>A 32-bit integer that specifies the variant data type for the crawled property.</returns>
  550. </member>
  551. <member name="T:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty">
  552. <summary>Defines the crawl log filter properties for the <see cref="M:Microsoft.Office.Server.Search.Administration.CrawlLogFilters.AddFilter"></see> method of the <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlLogFilters"></see> class.</summary>
  553. </member>
  554. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.CatalogType">
  555. <summary>Specifies the catalog type crawl log filter property.</summary>
  556. </member>
  557. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.ContentSourceId">
  558. <summary>Specifies the content source ID crawl log filter property.</summary>
  559. </member>
  560. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.HostName">
  561. <summary>Specifies the host name crawl log filter property.</summary>
  562. </member>
  563. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.MessageId">
  564. <summary>Specifies the message ID crawl log filter property.</summary>
  565. </member>
  566. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.MessageType">
  567. <summary>Specifies the message type crawl log filter property.</summary>
  568. </member>
  569. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.StartAt">
  570. <summary>Specifies the crawl start time crawl log filter property.</summary>
  571. </member>
  572. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.TotalEntries">
  573. <summary>Specifies the total entries crawl log filter property.</summary>
  574. </member>
  575. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.Url">
  576. <summary>Specifies the URL crawl log filter property.</summary>
  577. </member>
  578. <member name="F:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty.UrlLogTime">
  579. <summary>Specifies the URL log time crawl log filter property.</summary>
  580. </member>
  581. <member name="T:Microsoft.Office.Server.Search.Administration.CrawlLogFilters">
  582. <summary>Contains all the filters for manipulating the crawl log data.</summary>
  583. </member>
  584. <member name="M:Microsoft.Office.Server.Search.Administration.CrawlLogFilters.#ctor">
  585. <summary>Initializes a new instance of the <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlLogFilters"></see> class.</summary>
  586. </member>
  587. <member name="M:Microsoft.Office.Server.Search.Administration.CrawlLogFilters.AddFilter(Microsoft.Office.Server.Search.Administration.CatalogType)">
  588. <summary>Applies the specified catalog type filter to the crawl log data.</summary>
  589. <param name="catalogType">A value from the <see cref="T:Microsoft.Office.Server.Search.Administration.CatalogType"></see> enumeration specifying the catalog type to use for the crawl log filter.</param>
  590. </member>
  591. <member name="M:Microsoft.Office.Server.Search.Administration.CrawlLogFilters.AddFilter(Microsoft.Office.Server.Search.Administration.MessageType)">
  592. <summary>Applies the specified message type filter to the crawl log data.</summary>
  593. <param name="messageType">A value from the <see cref="T:Microsoft.Office.Server.Search.Administration.MessageType"></see> enumeration specifying the message type to use for the crawl log filter.</param>
  594. </member>
  595. <member name="M:Microsoft.Office.Server.Search.Administration.CrawlLogFilters.AddFilter(Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty,System.Int32)">
  596. <summary>Applies the specified filter property to the crawl log data.</summary>
  597. <param name="value">A 32-bit integer specifying the value to use for the property filter.</param>
  598. <param name="p rop">A value from the <see cref="T:Microsoft.Office.Server.Search.Administration.CrawlLogFilterProperty"></see> enumeration specifying the crawl log property to use

Large files files are truncated, but you can click here to view the full file