IEnumerableExtensionSerializeVcf Method

Serializes a collection of VCard objects into a Stream using the VCF format.

Definition

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

C#

public static void SerializeVcf(
	this IEnumerable<VCard?> vCards,
	Stream stream,
	VCdVersion version = VCdVersion.V3_0,
	ITimeZoneIDConverter? tzConverter = null,
	VcfOpts options = VcfOpts.Default,
	bool leaveStreamOpen = false
)

VB

<ExtensionAttribute>
Public Shared Sub SerializeVcf ( 
	vCards As IEnumerable(Of VCard),
	stream As Stream,
	Optional version As VCdVersion = VCdVersion.V3_0,
	Optional tzConverter As ITimeZoneIDConverter = Nothing,
	Optional options As VcfOpts = VcfOpts.Default,
	Optional leaveStreamOpen As Boolean = false
)

C++

public:
[ExtensionAttribute]
static void SerializeVcf(
	IEnumerable<VCard^>^ vCards, 
	Stream^ stream, 
	VCdVersion version = VCdVersion::V3_0, 
	ITimeZoneIDConverter^ tzConverter = nullptr, 
	VcfOpts options = VcfOpts::Default, 
	bool leaveStreamOpen = false
)

F#

[<ExtensionAttribute>]
static member SerializeVcf : 
        vCards : IEnumerable<VCard> * 
        stream : Stream * 
        ?version : VCdVersion * 
        ?tzConverter : ITimeZoneIDConverter * 
        ?options : VcfOpts * 
        ?leaveStreamOpen : bool 
(* Defaults:
        let _version = defaultArg version VCdVersion.V3_0
        let _tzConverter = defaultArg tzConverter null
        let _options = defaultArg options VcfOpts.Default
        let _leaveStreamOpen = defaultArg leaveStreamOpen false
*)
-> unit

Parameters

vCards IEnumerableVCard: The VCard objects to be serialized. The collection may be empty or may contain null values.
stream Stream: A Stream into which the serialized VCard objects are written.
version VCdVersion (Optional): The vCard version used for the serialization.
tzConverter ITimeZoneIDConverter (Optional): An object that implements ITimeZoneIDConverter to convert IANA time zone names to UTC offsets, or null.
options VcfOpts (Optional): Options for serializing VCF. The flags can be combined.
leaveStreamOpen Boolean (Optional): true means that the method does not close the underlying Stream. The default value is false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableVCard. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Caution

Although the method itself is thread-safe, the VCard objects passed to the method are not. Block read and write access to these VCard objects, while this method is being executed!

The method may serialize more vCards than the number of elements in the collection passed to the vCards parameter. This can happen if there are embedded VCard objects in the Members or Relations properties.

Exceptions

ArgumentNullException	stream or vCards is null.
ArgumentException	stream does not support write operations.
ArgumentOutOfRangeException	version is not a defined value of the VcfOpts enum.
IOException	I/O error.
ObjectDisposedException	stream was already closed.