Length Property

Summary

Maximum number of bytes to read during this download operation.

Syntax

C++

public long Length {get; set;}

Public Property Length() As Long 
   Get 
   Set

public:  
   property Int64 Length 
   { 
      Int64 get() 
      void set(Int64 value) 
   }

Property Value

Maximum number of bytes to read during this download operation. The default value is 0.

Remarks

DocumentFactory.DownloadDocument returns the total number of bytes read into Data or Stream. This value can be less than the number of bytes requested by Length, if that many bytes are not currently available, or zero (0) if the end of the data has been reached.

If this value is -1, then the remaining data will be read until the end is reached.

Example

For an example, refer to DocumentFactory.DownloadDocument.

Requirements

Target Platforms