System.Diagnostics.FileVersionInfo.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Diagnostics.FileVersionInfo</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Diagnostics.FileVersionInfo">
  8. <summary>Provides version information for a physical file on disk.</summary>
  9. <filterpriority>2</filterpriority>
  10. </member>
  11. <member name="P:System.Diagnostics.FileVersionInfo.Comments">
  12. <summary>Gets the comments associated with the file.</summary>
  13. <returns>The comments associated with the file or null if the file did not contain version information.</returns>
  14. <filterpriority>2</filterpriority>
  15. </member>
  16. <member name="P:System.Diagnostics.FileVersionInfo.CompanyName">
  17. <summary>Gets the name of the company that produced the file.</summary>
  18. <returns>The name of the company that produced the file or null if the file did not contain version information.</returns>
  19. <filterpriority>2</filterpriority>
  20. </member>
  21. <member name="P:System.Diagnostics.FileVersionInfo.FileBuildPart">
  22. <summary>Gets the build number of the file.</summary>
  23. <returns>A value representing the build number of the file or null if the file did not contain version information.</returns>
  24. <filterpriority>2</filterpriority>
  25. </member>
  26. <member name="P:System.Diagnostics.FileVersionInfo.FileDescription">
  27. <summary>Gets the description of the file.</summary>
  28. <returns>The description of the file or null if the file did not contain version information.</returns>
  29. <filterpriority>2</filterpriority>
  30. </member>
  31. <member name="P:System.Diagnostics.FileVersionInfo.FileMajorPart">
  32. <summary>Gets the major part of the version number.</summary>
  33. <returns>A value representing the major part of the version number or 0 (zero) if the file did not contain version information.</returns>
  34. <filterpriority>2</filterpriority>
  35. </member>
  36. <member name="P:System.Diagnostics.FileVersionInfo.FileMinorPart">
  37. <summary>Gets the minor part of the version number of the file.</summary>
  38. <returns>A value representing the minor part of the version number of the file or 0 (zero) if the file did not contain version information.</returns>
  39. <filterpriority>2</filterpriority>
  40. </member>
  41. <member name="P:System.Diagnostics.FileVersionInfo.FileName">
  42. <summary>Gets the name of the file that this instance of <see cref="T:System.Diagnostics.FileVersionInfo" /> describes.</summary>
  43. <returns>The name of the file described by this instance of <see cref="T:System.Diagnostics.FileVersionInfo" />.</returns>
  44. <filterpriority>2</filterpriority>
  45. </member>
  46. <member name="P:System.Diagnostics.FileVersionInfo.FilePrivatePart">
  47. <summary>Gets the file private part number.</summary>
  48. <returns>A value representing the file private part number or null if the file did not contain version information.</returns>
  49. <filterpriority>2</filterpriority>
  50. </member>
  51. <member name="P:System.Diagnostics.FileVersionInfo.FileVersion">
  52. <summary>Gets the file version number.</summary>
  53. <returns>The version number of the file or null if the file did not contain version information.</returns>
  54. <filterpriority>2</filterpriority>
  55. </member>
  56. <member name="M:System.Diagnostics.FileVersionInfo.GetVersionInfo(System.String)">
  57. <summary>Returns a <see cref="T:System.Diagnostics.FileVersionInfo" /> representing the version information associated with the specified file.</summary>
  58. <returns>A <see cref="T:System.Diagnostics.FileVersionInfo" /> containing information about the file. If the file did not contain version information, the <see cref="T:System.Diagnostics.FileVersionInfo" /> contains only the name of the file requested.</returns>
  59. <param name="fileName">The fully qualified path and name of the file to retrieve the version information for. </param>
  60. <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found. </exception>
  61. <filterpriority>1</filterpriority>
  62. </member>
  63. <member name="P:System.Diagnostics.FileVersionInfo.InternalName">
  64. <summary>Gets the internal name of the file, if one exists.</summary>
  65. <returns>The internal name of the file. If none exists, this property will contain the original name of the file without the extension.</returns>
  66. <filterpriority>2</filterpriority>
  67. </member>
  68. <member name="P:System.Diagnostics.FileVersionInfo.IsDebug">
  69. <summary>Gets a value that specifies whether the file contains debugging information or is compiled with debugging features enabled.</summary>
  70. <returns>true if the file contains debugging information or is compiled with debugging features enabled; otherwise, false.</returns>
  71. <filterpriority>2</filterpriority>
  72. </member>
  73. <member name="P:System.Diagnostics.FileVersionInfo.IsPatched">
  74. <summary>Gets a value that specifies whether the file has been modified and is not identical to the original shipping file of the same version number.</summary>
  75. <returns>true if the file is patched; otherwise, false.</returns>
  76. <filterpriority>2</filterpriority>
  77. </member>
  78. <member name="P:System.Diagnostics.FileVersionInfo.IsPreRelease">
  79. <summary>Gets a value that specifies whether the file is a development version, rather than a commercially released product.</summary>
  80. <returns>true if the file is prerelease; otherwise, false.</returns>
  81. <filterpriority>2</filterpriority>
  82. </member>
  83. <member name="P:System.Diagnostics.FileVersionInfo.IsPrivateBuild">
  84. <summary>Gets a value that specifies whether the file was built using standard release procedures.</summary>
  85. <returns>true if the file is a private build; false if the file was built using standard release procedures or if the file did not contain version information.</returns>
  86. <filterpriority>2</filterpriority>
  87. </member>
  88. <member name="P:System.Diagnostics.FileVersionInfo.IsSpecialBuild">
  89. <summary>Gets a value that specifies whether the file is a special build.</summary>
  90. <returns>true if the file is a special build; otherwise, false.</returns>
  91. <filterpriority>2</filterpriority>
  92. </member>
  93. <member name="P:System.Diagnostics.FileVersionInfo.Language">
  94. <summary>Gets the default language string for the version info block.</summary>
  95. <returns>The description string for the Microsoft Language Identifier in the version resource or null if the file did not contain version information.</returns>
  96. <filterpriority>2</filterpriority>
  97. </member>
  98. <member name="P:System.Diagnostics.FileVersionInfo.LegalCopyright">
  99. <summary>Gets all copyright notices that apply to the specified file.</summary>
  100. <returns>The copyright notices that apply to the specified file.</returns>
  101. <filterpriority>2</filterpriority>
  102. </member>
  103. <member name="P:System.Diagnostics.FileVersionInfo.LegalTrademarks">
  104. <summary>Gets the trademarks and registered trademarks that apply to the file.</summary>
  105. <returns>The trademarks and registered trademarks that apply to the file or null if the file did not contain version information.</returns>
  106. <filterpriority>2</filterpriority>
  107. </member>
  108. <member name="P:System.Diagnostics.FileVersionInfo.OriginalFilename">
  109. <summary>Gets the name the file was created with.</summary>
  110. <returns>The name the file was created with or null if the file did not contain version information.</returns>
  111. <filterpriority>2</filterpriority>
  112. </member>
  113. <member name="P:System.Diagnostics.FileVersionInfo.PrivateBuild">
  114. <summary>Gets information about a private version of the file.</summary>
  115. <returns>Information about a private version of the file or null if the file did not contain version information.</returns>
  116. <filterpriority>2</filterpriority>
  117. </member>
  118. <member name="P:System.Diagnostics.FileVersionInfo.ProductBuildPart">
  119. <summary>Gets the build number of the product this file is associated with.</summary>
  120. <returns>A value representing the build number of the product this file is associated with or null if the file did not contain version information.</returns>
  121. <filterpriority>2</filterpriority>
  122. </member>
  123. <member name="P:System.Diagnostics.FileVersionInfo.ProductMajorPart">
  124. <summary>Gets the major part of the version number for the product this file is associated with.</summary>
  125. <returns>A value representing the major part of the product version number or null if the file did not contain version information.</returns>
  126. <filterpriority>2</filterpriority>
  127. </member>
  128. <member name="P:System.Diagnostics.FileVersionInfo.ProductMinorPart">
  129. <summary>Gets the minor part of the version number for the product the file is associated with.</summary>
  130. <returns>A value representing the minor part of the product version number or null if the file did not contain version information.</returns>
  131. <filterpriority>2</filterpriority>
  132. </member>
  133. <member name="P:System.Diagnostics.FileVersionInfo.ProductName">
  134. <summary>Gets the name of the product this file is distributed with.</summary>
  135. <returns>The name of the product this file is distributed with or null if the file did not contain version information.</returns>
  136. <filterpriority>2</filterpriority>
  137. </member>
  138. <member name="P:System.Diagnostics.FileVersionInfo.ProductPrivatePart">
  139. <summary>Gets the private part number of the product this file is associated with.</summary>
  140. <returns>A value representing the private part number of the product this file is associated with or null if the file did not contain version information.</returns>
  141. <filterpriority>2</filterpriority>
  142. </member>
  143. <member name="P:System.Diagnostics.FileVersionInfo.ProductVersion">
  144. <summary>Gets the version of the product this file is distributed with.</summary>
  145. <returns>The version of the product this file is distributed with or null if the file did not contain version information.</returns>
  146. <filterpriority>2</filterpriority>
  147. </member>
  148. <member name="P:System.Diagnostics.FileVersionInfo.SpecialBuild">
  149. <summary>Gets the special build information for the file.</summary>
  150. <returns>The special build information for the file or null if the file did not contain version information.</returns>
  151. <filterpriority>2</filterpriority>
  152. </member>
  153. <member name="M:System.Diagnostics.FileVersionInfo.ToString">
  154. <summary>Returns a partial list of properties in the <see cref="T:System.Diagnostics.FileVersionInfo" /> and their values.</summary>
  155. <returns>A list of the following properties in this class and their values: <see cref="P:System.Diagnostics.FileVersionInfo.FileName" />, <see cref="P:System.Diagnostics.FileVersionInfo.InternalName" />, <see cref="P:System.Diagnostics.FileVersionInfo.OriginalFilename" />, <see cref="P:System.Diagnostics.FileVersionInfo.FileVersion" />, <see cref="P:System.Diagnostics.FileVersionInfo.FileDescription" />, <see cref="P:System.Diagnostics.FileVersionInfo.ProductName" />, <see cref="P:System.Diagnostics.FileVersionInfo.ProductVersion" />, <see cref="P:System.Diagnostics.FileVersionInfo.IsDebug" />, <see cref="P:System.Diagnostics.FileVersionInfo.IsPatched" />, <see cref="P:System.Diagnostics.FileVersionInfo.IsPreRelease" />, <see cref="P:System.Diagnostics.FileVersionInfo.IsPrivateBuild" />, <see cref="P:System.Diagnostics.FileVersionInfo.IsSpecialBuild" />,<see cref="P:System.Diagnostics.FileVersionInfo.Language" />.If the file did not contain version information, this list will contain only the name of the requested file. Boolean values will be false, and all other entries will be null.</returns>
  156. <filterpriority>2</filterpriority>
  157. </member>
  158. </members>
  159. </doc>