MetadataSerializer.ReadEntitiesDescriptor Method

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Reads entities descriptor.

Namespace: Microsoft.IdentityModel.Protocols.WSFederation.Metadata
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim reader As XmlReader
Dim tokenResolver As SecurityTokenResolver
Dim returnValue As EntitiesDescriptor

returnValue = Me.ReadEntitiesDescriptor(reader, tokenResolver)

Syntax

'Declaration
Protected Overridable Function ReadEntitiesDescriptor ( _
    reader As XmlReader, _
    tokenResolver As SecurityTokenResolver _
) As EntitiesDescriptor
protected virtual EntitiesDescriptor ReadEntitiesDescriptor (
    XmlReader reader,
    SecurityTokenResolver tokenResolver
)
protected:
virtual EntitiesDescriptor^ ReadEntitiesDescriptor (
    XmlReader^ reader, 
    SecurityTokenResolver^ tokenResolver
)
protected EntitiesDescriptor ReadEntitiesDescriptor (
    XmlReader reader, 
    SecurityTokenResolver tokenResolver
)
protected function ReadEntitiesDescriptor (
    reader : XmlReader, 
    tokenResolver : SecurityTokenResolver
) : EntitiesDescriptor

Parameters

  • reader
    Xml reader.
  • tokenResolver
    The security token resolver.

Return Value

The entities descriptor.

Exceptions

Exception type Condition
ArgumentNullException

The parameter reader is null.

MetadataSerializationException

Thrown if the XML is not well-formed.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

See Also

Reference

MetadataSerializer Class
MetadataSerializer Members
Microsoft.IdentityModel.Protocols.WSFederation.Metadata Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.