This documentation is archived and is not being maintained.

MetadataReference Class

Represents a reference to a metadata document returned from a metadata exchange endpoint.


Namespace:  System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public class MetadataReference : IXmlSerializable

The MetadataReference type exposes the following members.

Public methodMetadataReference()Initializes a new instance of the MetadataReference class.
Public methodMetadataReference(EndpointAddress, AddressingVersion)Initializes a new instance of the MetadataReference class and specifies the network address and address version of the endpoint.

Public propertyAddressGets or sets the network address of a service that returns metadata.
Public propertyAddressVersionGets or sets the version implemented in, or used by the endpoint.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate methodIXmlSerializable.GetSchemaReturns an XML schema document for the metadata reference endpoint.
Explicit interface implemetationPrivate methodIXmlSerializable.ReadXmlReads using the supplied reader object.
Explicit interface implemetationPrivate methodIXmlSerializable.WriteXmlWrites an XML stream with the specified writer object.

When using , a metadata endpoint can be created for any service. The endpoint can be queried for metadata that allows a client to communicate with the endpoint. For example, a metadata endpoint can return a Web Services Description Language (WSDL) document that describes the methods and data types of a service.

The MetadataReference class is used with WS-MetadataExchange responses where references are directly encoded as <mex:MetadataReference> or <mex:MetadataLocation>.

Metadata documents can reference many other documents that describe types and those documents can contain even more references. The MetadataReference class represents a single endpoint that returns a document that can itself contain multiple WSDL or XSD items as well as other metadata references to other WS-MetadataExchange endpoints.

Instances of the MetadataReference class are commonly used when processing a MetadataSet, which represents the total metadata exchange point. The MetadataResolver class is designed to resolve all references used to return the metadata. If, however, you need to examine each reference, use the MetadataReference class to represent each endpoint.


implements the Web Services Metadata Exchange (WS-MetadataExchange) specification for returning metadata. That specification further uses the Web Services Transfer (WS-Transfer) specification to define the mechanism for retrieving XML-based data.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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