VcfParse Method

Parses a String that represents the content of a VCF file.

Definition

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

C#

public static IReadOnlyList<VCard> Parse(
	string vcf
)

VB

Public Shared Function Parse ( 
	vcf As String
) As IReadOnlyList(Of VCard)

C++

public:
static IReadOnlyList<VCard^>^ Parse(
	String^ vcf
)

F#

static member Parse : 
        vcf : string -> IReadOnlyList<VCard>

Parameters

vcf String: A String that represents the content of a VCF file.

Return Value

IReadOnlyListVCard
A collection of parsed VCard objects, which represents the content of vcf.

Remarks

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

Example

C#

using FolkerKinzel.VCards;
using FolkerKinzel.VCards.Enums;

namespace Examples;

public static class NoPidExample
{
    public static void RemovePropertyIdentification()
    {
        const string vcf = """
            BEGIN:VCARD
            VERSION:4.0
            REV:20231121T200704Z
            UID:urn:uuid:5ad11c78-f4b1-4e70-b0ef-6f4c29cf97ea
            FN;PID=1.1:John Doe
            CLIENTPIDMAP:1;http://other.com/
            END:VCARD
            """;

        VCard vCard = Vcf.Parse(vcf)[0];

        // Removes all existing PIDs and CLIENTPIDMAPs
        vCard.Sync.Reset();

        Console.WriteLine(Vcf.AsString(vCard, VCdVersion.V4_0));
    }
}

/*
Console Output:

BEGIN:VCARD
VERSION:4.0
REV:20231121T201552Z
UID:urn:uuid:5ad11c78-f4b1-4e70-b0ef-6f4c29cf97ea
FN:John Doe
END:VCARD
*/

Exceptions

ArgumentNullException

vcf is null.