ContentRangeHeaderValue.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="ContentRangeHeaderValue" FullName="System.Net.Http.Headers.ContentRangeHeaderValue">
  3. <TypeSignature Language="C#" Value="public class ContentRangeHeaderValue : ICloneable" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ContentRangeHeaderValue extends System.Object implements class System.ICloneable" />
  5. <AssemblyInfo>
  6. <AssemblyName>System.Net.Http</AssemblyName>
  7. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.Object</BaseTypeName>
  11. </Base>
  12. <Interfaces>
  13. <Interface>
  14. <InterfaceName>System.ICloneable</InterfaceName>
  15. </Interface>
  16. </Interfaces>
  17. <Docs>
  18. <remarks>To be added.</remarks>
  19. <summary>
  20. <attribution license="cc4" from="Microsoft" modified="false" />
  21. <para>Represents the value of the Content-Range header.</para>
  22. </summary>
  23. </Docs>
  24. <Members>
  25. <Member MemberName=".ctor">
  26. <MemberSignature Language="C#" Value="public ContentRangeHeaderValue (long length);" />
  27. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 length) cil managed" />
  28. <MemberType>Constructor</MemberType>
  29. <AssemblyInfo>
  30. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  31. </AssemblyInfo>
  32. <Parameters>
  33. <Parameter Name="length" Type="System.Int64" />
  34. </Parameters>
  35. <Docs>
  36. <remarks>To be added.</remarks>
  37. <summary>
  38. <attribution license="cc4" from="Microsoft" modified="false" />
  39. <para>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> class.</para>
  40. </summary>
  41. <param name="length">
  42. <attribution license="cc4" from="Microsoft" modified="false" />The starting or ending point of the range, in bytes.</param>
  43. </Docs>
  44. </Member>
  45. <Member MemberName=".ctor">
  46. <MemberSignature Language="C#" Value="public ContentRangeHeaderValue (long from, long to);" />
  47. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 from, int64 to) cil managed" />
  48. <MemberType>Constructor</MemberType>
  49. <AssemblyInfo>
  50. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  51. </AssemblyInfo>
  52. <Parameters>
  53. <Parameter Name="from" Type="System.Int64" />
  54. <Parameter Name="to" Type="System.Int64" />
  55. </Parameters>
  56. <Docs>
  57. <remarks>To be added.</remarks>
  58. <summary>
  59. <attribution license="cc4" from="Microsoft" modified="false" />
  60. <para>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> class.</para>
  61. </summary>
  62. <param name="from">
  63. <attribution license="cc4" from="Microsoft" modified="false" />The position, in bytes, at which to start sending data.</param>
  64. <param name="to">
  65. <attribution license="cc4" from="Microsoft" modified="false" />The position, in bytes, at which to stop sending data.</param>
  66. </Docs>
  67. </Member>
  68. <Member MemberName=".ctor">
  69. <MemberSignature Language="C#" Value="public ContentRangeHeaderValue (long from, long to, long length);" />
  70. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 from, int64 to, int64 length) cil managed" />
  71. <MemberType>Constructor</MemberType>
  72. <AssemblyInfo>
  73. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  74. </AssemblyInfo>
  75. <Parameters>
  76. <Parameter Name="from" Type="System.Int64" />
  77. <Parameter Name="to" Type="System.Int64" />
  78. <Parameter Name="length" Type="System.Int64" />
  79. </Parameters>
  80. <Docs>
  81. <remarks>To be added.</remarks>
  82. <summary>
  83. <attribution license="cc4" from="Microsoft" modified="false" />
  84. <para>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> class.</para>
  85. </summary>
  86. <param name="from">
  87. <attribution license="cc4" from="Microsoft" modified="false" />The position, in bytes, at which to start sending data.</param>
  88. <param name="to">
  89. <attribution license="cc4" from="Microsoft" modified="false" />The position, in bytes, at which to stop sending data.</param>
  90. <param name="length">
  91. <attribution license="cc4" from="Microsoft" modified="false" />The starting or ending point of the range, in bytes.</param>
  92. </Docs>
  93. </Member>
  94. <Member MemberName="Equals">
  95. <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
  96. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
  97. <MemberType>Method</MemberType>
  98. <AssemblyInfo>
  99. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  100. </AssemblyInfo>
  101. <ReturnValue>
  102. <ReturnType>System.Boolean</ReturnType>
  103. </ReturnValue>
  104. <Parameters>
  105. <Parameter Name="obj" Type="System.Object" />
  106. </Parameters>
  107. <Docs>
  108. <remarks>To be added.</remarks>
  109. <summary>
  110. <attribution license="cc4" from="Microsoft" modified="false" />
  111. <para>Determines whether the specified Object is equal to the current <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> object.</para>
  112. </summary>
  113. <returns>
  114. <attribution license="cc4" from="Microsoft" modified="false" />
  115. <para>Returns <see cref="T:System.Boolean" />.</para>
  116. <para>true if the specified <see cref="T:System.Object" /> is equal to the current object; otherwise, false.</para>
  117. </returns>
  118. <param name="obj">
  119. <attribution license="cc4" from="Microsoft" modified="false" />The object to compare with the current object.</param>
  120. </Docs>
  121. </Member>
  122. <Member MemberName="From">
  123. <MemberSignature Language="C#" Value="public Nullable&lt;long&gt; From { get; }" />
  124. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int64&gt; From" />
  125. <MemberType>Property</MemberType>
  126. <AssemblyInfo>
  127. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  128. </AssemblyInfo>
  129. <ReturnValue>
  130. <ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
  131. </ReturnValue>
  132. <Docs>
  133. <value>To be added.</value>
  134. <remarks>To be added.</remarks>
  135. <summary>
  136. <attribution license="cc4" from="Microsoft" modified="false" />
  137. <para>Gets the position at which to start sending data.</para>
  138. </summary>
  139. </Docs>
  140. </Member>
  141. <Member MemberName="GetHashCode">
  142. <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
  143. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
  144. <MemberType>Method</MemberType>
  145. <AssemblyInfo>
  146. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  147. </AssemblyInfo>
  148. <ReturnValue>
  149. <ReturnType>System.Int32</ReturnType>
  150. </ReturnValue>
  151. <Parameters />
  152. <Docs>
  153. <remarks>
  154. <attribution license="cc4" from="Microsoft" modified="false" />
  155. <para>A hash code is a numeric value that is used to identify an object during equality testing. It can also serve as an index for an object in a collection.</para>
  156. <para>The <see cref="M:System.Net.Http.Headers.ContentRangeHeaderValue.GetHashCode" /> method is suitable for use in hashing algorithms and data structures such as a hash table.</para>
  157. </remarks>
  158. <summary>
  159. <attribution license="cc4" from="Microsoft" modified="false" />
  160. <para>Serves as a hash function for an <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> object.</para>
  161. </summary>
  162. <returns>
  163. <attribution license="cc4" from="Microsoft" modified="false" />
  164. <para>Returns <see cref="T:System.Int32" />.</para>
  165. <para>A hash code for the current object.</para>
  166. </returns>
  167. </Docs>
  168. </Member>
  169. <Member MemberName="HasLength">
  170. <MemberSignature Language="C#" Value="public bool HasLength { get; }" />
  171. <MemberSignature Language="ILAsm" Value=".property instance bool HasLength" />
  172. <MemberType>Property</MemberType>
  173. <AssemblyInfo>
  174. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  175. </AssemblyInfo>
  176. <ReturnValue>
  177. <ReturnType>System.Boolean</ReturnType>
  178. </ReturnValue>
  179. <Docs>
  180. <value>To be added.</value>
  181. <remarks>To be added.</remarks>
  182. <summary>
  183. <attribution license="cc4" from="Microsoft" modified="false" />
  184. <para>Gets whether the Content-Range header has a length specified.</para>
  185. </summary>
  186. </Docs>
  187. </Member>
  188. <Member MemberName="HasRange">
  189. <MemberSignature Language="C#" Value="public bool HasRange { get; }" />
  190. <MemberSignature Language="ILAsm" Value=".property instance bool HasRange" />
  191. <MemberType>Property</MemberType>
  192. <AssemblyInfo>
  193. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  194. </AssemblyInfo>
  195. <ReturnValue>
  196. <ReturnType>System.Boolean</ReturnType>
  197. </ReturnValue>
  198. <Docs>
  199. <value>To be added.</value>
  200. <remarks>To be added.</remarks>
  201. <summary>
  202. <attribution license="cc4" from="Microsoft" modified="false" />
  203. <para>Gets whether the Content-Range has a range specified. </para>
  204. </summary>
  205. </Docs>
  206. </Member>
  207. <Member MemberName="Length">
  208. <MemberSignature Language="C#" Value="public Nullable&lt;long&gt; Length { get; }" />
  209. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int64&gt; Length" />
  210. <MemberType>Property</MemberType>
  211. <AssemblyInfo>
  212. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  213. </AssemblyInfo>
  214. <ReturnValue>
  215. <ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
  216. </ReturnValue>
  217. <Docs>
  218. <value>To be added.</value>
  219. <remarks>To be added.</remarks>
  220. <summary>
  221. <attribution license="cc4" from="Microsoft" modified="false" />
  222. <para>Gets the length of the full entity-body.</para>
  223. </summary>
  224. </Docs>
  225. </Member>
  226. <Member MemberName="Parse">
  227. <MemberSignature Language="C#" Value="public static System.Net.Http.Headers.ContentRangeHeaderValue Parse (string input);" />
  228. <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Http.Headers.ContentRangeHeaderValue Parse(string input) cil managed" />
  229. <MemberType>Method</MemberType>
  230. <AssemblyInfo>
  231. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  232. </AssemblyInfo>
  233. <ReturnValue>
  234. <ReturnType>System.Net.Http.Headers.ContentRangeHeaderValue</ReturnType>
  235. </ReturnValue>
  236. <Parameters>
  237. <Parameter Name="input" Type="System.String" />
  238. </Parameters>
  239. <Docs>
  240. <remarks>To be added.</remarks>
  241. <summary>
  242. <attribution license="cc4" from="Microsoft" modified="false" />
  243. <para>Converts a string to an <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> instance.</para>
  244. </summary>
  245. <returns>
  246. <attribution license="cc4" from="Microsoft" modified="false" />
  247. <para>Returns <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" />.</para>
  248. <para>An <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> instance.</para>
  249. </returns>
  250. <param name="input">
  251. <attribution license="cc4" from="Microsoft" modified="false" />A string that represents content range header value information.</param>
  252. </Docs>
  253. </Member>
  254. <Member MemberName="System.ICloneable.Clone">
  255. <MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
  256. <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance object System.ICloneable.Clone() cil managed" />
  257. <MemberType>Method</MemberType>
  258. <AssemblyInfo>
  259. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  260. </AssemblyInfo>
  261. <ReturnValue>
  262. <ReturnType>System.Object</ReturnType>
  263. </ReturnValue>
  264. <Parameters />
  265. <Docs>
  266. <remarks>To be added.</remarks>
  267. <summary>
  268. <attribution license="cc4" from="Microsoft" modified="false" />
  269. <para>Creates a new object that is a copy of the current <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> instance.</para>
  270. </summary>
  271. <returns>
  272. <attribution license="cc4" from="Microsoft" modified="false" />
  273. <para>Returns <see cref="T:System.Object" />.</para>
  274. <para>A copy of the current instance.</para>
  275. </returns>
  276. </Docs>
  277. </Member>
  278. <Member MemberName="To">
  279. <MemberSignature Language="C#" Value="public Nullable&lt;long&gt; To { get; }" />
  280. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int64&gt; To" />
  281. <MemberType>Property</MemberType>
  282. <AssemblyInfo>
  283. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  284. </AssemblyInfo>
  285. <ReturnValue>
  286. <ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
  287. </ReturnValue>
  288. <Docs>
  289. <value>To be added.</value>
  290. <remarks>To be added.</remarks>
  291. <summary>
  292. <attribution license="cc4" from="Microsoft" modified="false" />
  293. <para>Gets the position at which to stop sending data.</para>
  294. </summary>
  295. </Docs>
  296. </Member>
  297. <Member MemberName="ToString">
  298. <MemberSignature Language="C#" Value="public override string ToString ();" />
  299. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
  300. <MemberType>Method</MemberType>
  301. <AssemblyInfo>
  302. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  303. </AssemblyInfo>
  304. <ReturnValue>
  305. <ReturnType>System.String</ReturnType>
  306. </ReturnValue>
  307. <Parameters />
  308. <Docs>
  309. <remarks>To be added.</remarks>
  310. <summary>
  311. <attribution license="cc4" from="Microsoft" modified="false" />
  312. <para>Returns a string that represents the current <see cref="T:System.Net.Http.Headers.ContentRangeHeaderValue" /> object.</para>
  313. </summary>
  314. <returns>
  315. <attribution license="cc4" from="Microsoft" modified="false" />
  316. <para>Returns <see cref="T:System.String" />.</para>
  317. <para>A string that represents the current object.</para>
  318. </returns>
  319. </Docs>
  320. </Member>
  321. <Member MemberName="TryParse">
  322. <MemberSignature Language="C#" Value="public static bool TryParse (string input, out System.Net.Http.Headers.ContentRangeHeaderValue parsedValue);" />
  323. <MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryParse(string input, class System.Net.Http.Headers.ContentRangeHeaderValue parsedValue) cil managed" />
  324. <MemberType>Method</MemberType>
  325. <AssemblyInfo>
  326. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  327. </AssemblyInfo>
  328. <ReturnValue>
  329. <ReturnType>System.Boolean</ReturnType>
  330. </ReturnValue>
  331. <Parameters>
  332. <Parameter Name="input" Type="System.String" />
  333. <Parameter Name="parsedValue" Type="System.Net.Http.Headers.ContentRangeHeaderValue&amp;" RefType="out" />
  334. </Parameters>
  335. <Docs>
  336. <param name="input">To be added.</param>
  337. <param name="parsedValue">To be added.</param>
  338. <summary>To be added.</summary>
  339. <returns>To be added.</returns>
  340. <remarks>To be added.</remarks>
  341. </Docs>
  342. </Member>
  343. <Member MemberName="Unit">
  344. <MemberSignature Language="C#" Value="public string Unit { get; set; }" />
  345. <MemberSignature Language="ILAsm" Value=".property instance string Unit" />
  346. <MemberType>Property</MemberType>
  347. <AssemblyInfo>
  348. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  349. </AssemblyInfo>
  350. <ReturnValue>
  351. <ReturnType>System.String</ReturnType>
  352. </ReturnValue>
  353. <Docs>
  354. <value>To be added.</value>
  355. <remarks>
  356. <attribution license="cc4" from="Microsoft" modified="false" />
  357. <para>The only range unit defined by HTTP/1.1 is "bytes".</para>
  358. </remarks>
  359. <summary>
  360. <attribution license="cc4" from="Microsoft" modified="false" />
  361. <para>The range units used.</para>
  362. </summary>
  363. </Docs>
  364. </Member>
  365. </Members>
  366. </Type>