Microsoft.Practices.ServiceLocation.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Practices.ServiceLocation</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Practices.ServiceLocation.ActivationException">
  8. <summary>
  9. The standard exception thrown when a ServiceLocator has an error in resolving an object.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Practices.ServiceLocation.ActivationException.#ctor">
  13. <summary>
  14. Initializes a new instance of the <see cref="T:System.Exception" /> class.
  15. </summary>
  16. </member>
  17. <member name="M:Microsoft.Practices.ServiceLocation.ActivationException.#ctor(System.String)">
  18. <summary>
  19. Initializes a new instance of the <see cref="T:System.Exception" /> class with a specified error message.
  20. </summary>
  21. <param name="message">
  22. The message that describes the error.
  23. </param>
  24. </member>
  25. <member name="M:Microsoft.Practices.ServiceLocation.ActivationException.#ctor(System.String,System.Exception)">
  26. <summary>
  27. Initializes a new instance of the <see cref="T:System.Exception" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.
  28. </summary>
  29. <param name="message">
  30. The error message that explains the reason for the exception.
  31. </param>
  32. <param name="innerException">
  33. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.
  34. </param>
  35. </member>
  36. <member name="T:Microsoft.Practices.ServiceLocation.IServiceLocator">
  37. <summary>
  38. The generic Service Locator interface. This interface is used
  39. to retrieve services (instances identified by type and optional
  40. name) from a container.
  41. </summary>
  42. </member>
  43. <member name="M:Microsoft.Practices.ServiceLocation.IServiceLocator.GetInstance(System.Type)">
  44. <summary>
  45. Get an instance of the given <paramref name="serviceType"/>.
  46. </summary>
  47. <param name="serviceType">Type of object requested.</param>
  48. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is an error resolving
  49. the service instance.</exception>
  50. <returns>The requested service instance.</returns>
  51. </member>
  52. <member name="M:Microsoft.Practices.ServiceLocation.IServiceLocator.GetInstance(System.Type,System.String)">
  53. <summary>
  54. Get an instance of the given named <paramref name="serviceType"/>.
  55. </summary>
  56. <param name="serviceType">Type of object requested.</param>
  57. <param name="key">Name the object was registered with.</param>
  58. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is an error resolving
  59. the service instance.</exception>
  60. <returns>The requested service instance.</returns>
  61. </member>
  62. <member name="M:Microsoft.Practices.ServiceLocation.IServiceLocator.GetAllInstances(System.Type)">
  63. <summary>
  64. Get all instances of the given <paramref name="serviceType"/> currently
  65. registered in the container.
  66. </summary>
  67. <param name="serviceType">Type of object requested.</param>
  68. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  69. the service instance.</exception>
  70. <returns>A sequence of instances of the requested <paramref name="serviceType"/>.</returns>
  71. </member>
  72. <member name="M:Microsoft.Practices.ServiceLocation.IServiceLocator.GetInstance``1">
  73. <summary>
  74. Get an instance of the given <typeparamref name="TService"/>.
  75. </summary>
  76. <typeparam name="TService">Type of object requested.</typeparam>
  77. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  78. the service instance.</exception>
  79. <returns>The requested service instance.</returns>
  80. </member>
  81. <member name="M:Microsoft.Practices.ServiceLocation.IServiceLocator.GetInstance``1(System.String)">
  82. <summary>
  83. Get an instance of the given named <typeparamref name="TService"/>.
  84. </summary>
  85. <typeparam name="TService">Type of object requested.</typeparam>
  86. <param name="key">Name the object was registered with.</param>
  87. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  88. the service instance.</exception>
  89. <returns>The requested service instance.</returns>
  90. </member>
  91. <member name="M:Microsoft.Practices.ServiceLocation.IServiceLocator.GetAllInstances``1">
  92. <summary>
  93. Get all instances of the given <typeparamref name="TService"/> currently
  94. registered in the container.
  95. </summary>
  96. <typeparam name="TService">Type of object requested.</typeparam>
  97. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  98. the service instance.</exception>
  99. <returns>A sequence of instances of the requested <typeparamref name="TService"/>.</returns>
  100. </member>
  101. <member name="T:Microsoft.Practices.ServiceLocation.Properties.Resources">
  102. <summary>
  103. A strongly-typed resource class, for looking up localized strings, etc.
  104. </summary>
  105. </member>
  106. <member name="P:Microsoft.Practices.ServiceLocation.Properties.Resources.ResourceManager">
  107. <summary>
  108. Returns the cached ResourceManager instance used by this class.
  109. </summary>
  110. </member>
  111. <member name="P:Microsoft.Practices.ServiceLocation.Properties.Resources.Culture">
  112. <summary>
  113. Overrides the current thread's CurrentUICulture property for all
  114. resource lookups using this strongly typed resource class.
  115. </summary>
  116. </member>
  117. <member name="P:Microsoft.Practices.ServiceLocation.Properties.Resources.ActivateAllExceptionMessage">
  118. <summary>
  119. Looks up a localized string similar to Activation error occured while trying to get all instances of type {0}.
  120. </summary>
  121. </member>
  122. <member name="P:Microsoft.Practices.ServiceLocation.Properties.Resources.ActivationExceptionMessage">
  123. <summary>
  124. Looks up a localized string similar to Activation error occured while trying to get instance of type {0}, key &quot;{1}&quot;.
  125. </summary>
  126. </member>
  127. <member name="T:Microsoft.Practices.ServiceLocation.ServiceLocator">
  128. <summary>
  129. This class provides the ambient container for this application. If your
  130. framework defines such an ambient container, use ServiceLocator.Current
  131. to get it.
  132. </summary>
  133. </member>
  134. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocator.SetLocatorProvider(Microsoft.Practices.ServiceLocation.ServiceLocatorProvider)">
  135. <summary>
  136. Set the delegate that is used to retrieve the current container.
  137. </summary>
  138. <param name="newProvider">Delegate that, when called, will return
  139. the current ambient container.</param>
  140. </member>
  141. <member name="P:Microsoft.Practices.ServiceLocation.ServiceLocator.Current">
  142. <summary>
  143. The current ambient container.
  144. </summary>
  145. </member>
  146. <member name="T:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase">
  147. <summary>
  148. This class is a helper that provides a default implementation
  149. for most of the methods of <see cref="T:Microsoft.Practices.ServiceLocation.IServiceLocator"/>.
  150. </summary>
  151. </member>
  152. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.GetService(System.Type)">
  153. <summary>
  154. Get an instance of the given <paramref name="serviceType"/>.
  155. </summary>
  156. <param name="serviceType">The requested service.</param>
  157. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is an error in resolving the service instance.</exception>
  158. <returns>The requested object.</returns>
  159. </member>
  160. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.GetInstance(System.Type)">
  161. <summary>
  162. Get an instance of the given <paramref name="serviceType"/>.
  163. </summary>
  164. <param name="serviceType">Type of object requested.</param>
  165. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is an error resolving
  166. the service instance.</exception>
  167. <returns>The requested service instance.</returns>
  168. </member>
  169. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.GetInstance(System.Type,System.String)">
  170. <summary>
  171. Get an instance of the given named <paramref name="serviceType"/>.
  172. </summary>
  173. <param name="serviceType">Type of object requested.</param>
  174. <param name="key">Name the object was registered with.</param>
  175. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is an error resolving
  176. the service instance.</exception>
  177. <returns>The requested service instance.</returns>
  178. </member>
  179. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.GetAllInstances(System.Type)">
  180. <summary>
  181. Get all instances of the given <paramref name="serviceType"/> currently
  182. registered in the container.
  183. </summary>
  184. <param name="serviceType">Type of object requested.</param>
  185. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  186. the service instance.</exception>
  187. <returns>A sequence of instances of the requested <paramref name="serviceType"/>.</returns>
  188. </member>
  189. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.GetInstance``1">
  190. <summary>
  191. Get an instance of the given <typeparamref name="TService"/>.
  192. </summary>
  193. <typeparam name="TService">Type of object requested.</typeparam>
  194. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  195. the service instance.</exception>
  196. <returns>The requested service instance.</returns>
  197. </member>
  198. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.GetInstance``1(System.String)">
  199. <summary>
  200. Get an instance of the given named <typeparamref name="TService"/>.
  201. </summary>
  202. <typeparam name="TService">Type of object requested.</typeparam>
  203. <param name="key">Name the object was registered with.</param>
  204. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  205. the service instance.</exception>
  206. <returns>The requested service instance.</returns>
  207. </member>
  208. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.GetAllInstances``1">
  209. <summary>
  210. Get all instances of the given <typeparamref name="TService"/> currently
  211. registered in the container.
  212. </summary>
  213. <typeparam name="TService">Type of object requested.</typeparam>
  214. <exception cref="T:Microsoft.Practices.ServiceLocation.ActivationException">if there is are errors resolving
  215. the service instance.</exception>
  216. <returns>A sequence of instances of the requested <typeparamref name="TService"/>.</returns>
  217. </member>
  218. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.DoGetInstance(System.Type,System.String)">
  219. <summary>
  220. When implemented by inheriting classes, this method will do the actual work of resolving
  221. the requested service instance.
  222. </summary>
  223. <param name="serviceType">Type of instance requested.</param>
  224. <param name="key">Name of registered service you want. May be null.</param>
  225. <returns>The requested service instance.</returns>
  226. </member>
  227. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.DoGetAllInstances(System.Type)">
  228. <summary>
  229. When implemented by inheriting classes, this method will do the actual work of
  230. resolving all the requested service instances.
  231. </summary>
  232. <param name="serviceType">Type of service requested.</param>
  233. <returns>Sequence of service instance objects.</returns>
  234. </member>
  235. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.FormatActivationExceptionMessage(System.Exception,System.Type,System.String)">
  236. <summary>
  237. Format the exception message for use in an <see cref="T:Microsoft.Practices.ServiceLocation.ActivationException"/>
  238. that occurs while resolving a single service.
  239. </summary>
  240. <param name="actualException">The actual exception thrown by the implementation.</param>
  241. <param name="serviceType">Type of service requested.</param>
  242. <param name="key">Name requested.</param>
  243. <returns>The formatted exception message string.</returns>
  244. </member>
  245. <member name="M:Microsoft.Practices.ServiceLocation.ServiceLocatorImplBase.FormatActivateAllExceptionMessage(System.Exception,System.Type)">
  246. <summary>
  247. Format the exception message for use in an <see cref="T:Microsoft.Practices.ServiceLocation.ActivationException"/>
  248. that occurs while resolving multiple service instances.
  249. </summary>
  250. <param name="actualException">The actual exception thrown by the implementation.</param>
  251. <param name="serviceType">Type of service requested.</param>
  252. <returns>The formatted exception message string.</returns>
  253. </member>
  254. <member name="T:Microsoft.Practices.ServiceLocation.ServiceLocatorProvider">
  255. <summary>
  256. This delegate type is used to provide a method that will
  257. return the current container. Used with the <see cref="T:Microsoft.Practices.ServiceLocation.ServiceLocator"/>
  258. static accessor class.
  259. </summary>
  260. <returns>An <see cref="T:Microsoft.Practices.ServiceLocation.IServiceLocator"/>.</returns>
  261. </member>
  262. </members>
  263. </doc>