Microsoft.VisualStudio.TestPlatform.TestFramework.Extensions.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.VisualStudio.TestPlatform.TestFramework.Extensions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.VisualStudio.TestTools.UnitTesting.DeploymentItemAttribute">
  8. <summary>
  9. Used to specify deployment item (file or directory) per-test deployment for copying files or folders specified as deployment items to the <see cref="T:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext"/>.DeploymentDirectory.
  10. Deployment directory is where all the deployment items are present along with TestSource dll.
  11. Can be specified on test class or test method.
  12. Can have multiple instances of the attribute to specify more than one item.
  13. The item path can be absolute or relative, if relative, it is relative to RunConfig.RelativePathRoot.
  14. </summary>
  15. <remarks>
  16. If specified on a test class, the class needs to contain at least one test method. This means that the
  17. attribute cannot be combined with a test class that would contain only a AssemblyInitialize or ClassInitialize
  18. method.
  19. </remarks>
  20. <example>
  21. [DeploymentItem("file1.xml")]
  22. [DeploymentItem("file2.xml", "DataFiles")]
  23. [DeploymentItem("bin\Debug")].
  24. </example>
  25. </member>
  26. <member name="M:Microsoft.VisualStudio.TestTools.UnitTesting.DeploymentItemAttribute.#ctor(System.String)">
  27. <summary>
  28. Initializes a new instance of the <see cref="T:Microsoft.VisualStudio.TestTools.UnitTesting.DeploymentItemAttribute"/> class.
  29. </summary>
  30. <param name="path">The file or directory to deploy. The path is relative to the build output directory. The item will be copied to the same directory as the deployed test assemblies.</param>
  31. </member>
  32. <member name="M:Microsoft.VisualStudio.TestTools.UnitTesting.DeploymentItemAttribute.#ctor(System.String,System.String)">
  33. <summary>
  34. Initializes a new instance of the <see cref="T:Microsoft.VisualStudio.TestTools.UnitTesting.DeploymentItemAttribute"/> class.
  35. </summary>
  36. <param name="path">The relative or absolute path to the file or directory to deploy. The path is relative to the build output directory. The item will be copied to the same directory as the deployed test assemblies.</param>
  37. <param name="outputDirectory">The path of the directory to which the items are to be copied. It can be either absolute or relative to the deployment directory. All files and directories identified by <paramref name="path"/> will be copied to this directory.</param>
  38. </member>
  39. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.DeploymentItemAttribute.Path">
  40. <summary>
  41. Gets the path of the source file or folder to be copied.
  42. </summary>
  43. </member>
  44. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.DeploymentItemAttribute.OutputDirectory">
  45. <summary>
  46. Gets the path of the directory to which the item is copied.
  47. </summary>
  48. </member>
  49. <member name="T:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext">
  50. <summary>
  51. Used to store information that is provided to unit tests.
  52. </summary>
  53. </member>
  54. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.Properties">
  55. <summary>
  56. Gets test properties for a test.
  57. </summary>
  58. </member>
  59. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.CancellationTokenSource">
  60. <summary>
  61. Gets or sets the cancellation token source. This token source is canceled when test times out. Also when explicitly canceled the test will be aborted.
  62. </summary>
  63. </member>
  64. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestRunDirectory">
  65. <summary>
  66. Gets base directory for the test run, under which deployed files and result files are stored.
  67. </summary>
  68. </member>
  69. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.DeploymentDirectory">
  70. <summary>
  71. Gets directory for files deployed for the test run. Typically a subdirectory of <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestRunDirectory"/>.
  72. </summary>
  73. </member>
  74. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.ResultsDirectory">
  75. <summary>
  76. Gets base directory for results from the test run. Typically a subdirectory of <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestRunDirectory"/>.
  77. </summary>
  78. </member>
  79. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestRunResultsDirectory">
  80. <summary>
  81. Gets directory for test run result files. Typically a subdirectory of <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.ResultsDirectory"/>.
  82. </summary>
  83. </member>
  84. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestResultsDirectory">
  85. <summary>
  86. Gets directory for test result files.
  87. </summary>
  88. </member>
  89. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestDir">
  90. <summary>
  91. Gets base directory for the test run, under which deployed files and result files are stored.
  92. Same as <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestRunDirectory"/>. Use that property instead.
  93. </summary>
  94. </member>
  95. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestDeploymentDir">
  96. <summary>
  97. Gets directory for files deployed for the test run. Typically a subdirectory of <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestRunDirectory"/>.
  98. Same as <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.DeploymentDirectory"/>. Use that property instead.
  99. </summary>
  100. </member>
  101. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestLogsDir">
  102. <summary>
  103. Gets directory for test run result files. Typically a subdirectory of <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.ResultsDirectory"/>.
  104. Same as <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestRunResultsDirectory"/>. Use that property for test run result files, or
  105. <see cref="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestResultsDirectory"/> for test-specific result files instead.
  106. </summary>
  107. </member>
  108. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.FullyQualifiedTestClassName">
  109. <summary>
  110. Gets the Fully-qualified name of the class containing the test method currently being executed.
  111. </summary>
  112. <remarks>
  113. This property can be useful in attributes derived from ExpectedExceptionBaseAttribute.
  114. Those attributes have access to the test context, and provide messages that are included
  115. in the test results. Users can benefit from messages that include the fully-qualified
  116. class name in addition to the name of the test method currently being executed.
  117. </remarks>
  118. </member>
  119. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.ManagedType">
  120. <summary>
  121. Gets the fully specified type name metadata format.
  122. </summary>
  123. </member>
  124. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.ManagedMethod">
  125. <summary>
  126. Gets the fully specified method name metadata format.
  127. </summary>
  128. </member>
  129. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.TestName">
  130. <summary>
  131. Gets the name of the test method currently being executed.
  132. </summary>
  133. </member>
  134. <member name="P:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.CurrentTestOutcome">
  135. <summary>
  136. Gets the current test outcome.
  137. </summary>
  138. </member>
  139. <member name="M:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.AddResultFile(System.String)">
  140. <summary>
  141. Adds a file name to the list in TestResult.ResultFileNames.
  142. </summary>
  143. <param name="fileName">
  144. The file Name.
  145. </param>
  146. </member>
  147. <member name="M:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.Write(System.String)">
  148. <summary>
  149. Used to write trace messages while the test is running.
  150. </summary>
  151. <param name="message">formatted message string.</param>
  152. </member>
  153. <member name="M:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.Write(System.String,System.Object[])">
  154. <summary>
  155. Used to write trace messages while the test is running.
  156. </summary>
  157. <param name="format">format string.</param>
  158. <param name="args">the arguments.</param>
  159. </member>
  160. <member name="M:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.WriteLine(System.String)">
  161. <summary>
  162. Used to write trace messages while the test is running.
  163. </summary>
  164. <param name="message">formatted message string.</param>
  165. </member>
  166. <member name="M:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.WriteLine(System.String,System.Object[])">
  167. <summary>
  168. Used to write trace messages while the test is running.
  169. </summary>
  170. <param name="format">format string.</param>
  171. <param name="args">the arguments.</param>
  172. </member>
  173. </members>
  174. </doc>