VcfDeserialize(Stream, Encoding, Boolean) Method

Deserializes a Stream of VCF data.

Definition

Namespace: FolkerKinzel.VCards
Assembly: FolkerKinzel.VCards (in FolkerKinzel.VCards.dll) Version: 8.0.1+a91cc3f0fd39aeb548e16006a60ca9dd10a304a2

C#

public static IReadOnlyList<VCard> Deserialize(
	Stream stream,
	Encoding? textEncoding = null,
	bool leaveStreamOpen = false
)

VB

Public Shared Function Deserialize ( 
	stream As Stream,
	Optional textEncoding As Encoding = Nothing,
	Optional leaveStreamOpen As Boolean = false
) As IReadOnlyList(Of VCard)

C++

public:
static IReadOnlyList<VCard^>^ Deserialize(
	Stream^ stream, 
	Encoding^ textEncoding = nullptr, 
	bool leaveStreamOpen = false
)

F#

static member Deserialize : 
        stream : Stream * 
        ?textEncoding : Encoding * 
        ?leaveStreamOpen : bool 
(* Defaults:
        let _textEncoding = defaultArg textEncoding null
        let _leaveStreamOpen = defaultArg leaveStreamOpen false
*)
-> IReadOnlyList<VCard>

Parameters

stream Stream: The Stream to deserialize.
textEncoding Encoding (Optional): The text encoding to use for deserialization or null, to deserialize the Stream with the standard-compliant text encoding UTF8.
leaveStreamOpen Boolean (Optional): true means that stream will not be closed by the method. The default value is false to close stream when the method returns.

Return Value

IReadOnlyListVCard
A collection of parsed VCard objects.

Remarks

When the method completes, the Dereference(IEnumerableVCard) method has already been called on the return value.

Exceptions

ArgumentNullException	stream is null.
ArgumentException	stream doesn't support reading.
ObjectDisposedException	stream was closed.
IOException	Could not read from stream.