IPdfStreamProvider.GetStream Method

Gets a stream with initial capacity not less than specified.

Namespace:  BitMiracle.Docotic.Pdf
Assembly:  BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)


Stream GetStream(
	long capacity
Function GetStream ( 
	capacity As Long
) As Stream


Type: System.Int64
Minimum initial capacity of the stream.

Return Value

Type: Stream
Returns a stream with initial capacity not less than specified by the capacity.


The stream must be readable, seekable and writable.

Caller of the method is responsible for disposing of the returned stream.

The library tries to specify size of the stream beforehand but it's possible for the library to request zero length streams and then increase streams length by writing to the stream.

Streams can be of almost any length from a few bytes to several megabytes.

Streams can be used for a short period of time or for the lifetime of the PDF document.

See Also