WsdlExporter Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Converts service, contract, and endpoint information into metadata documents.

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

System.Object
  System.ServiceModel.Description.MetadataExporter
    System.ServiceModel.Description.WsdlExporter

Public Class WsdlExporter
	Inherits MetadataExporter

NameDescription
System_CAPS_pubmethodWsdlExporter()

Initializes a new instance of the WsdlExporter class.

NameDescription
System_CAPS_pubpropertyErrors

Gets a collection of errors that occurred during metadata export.(Inherited from MetadataExporter.)

System_CAPS_pubpropertyGeneratedWsdlDocuments

Gets a collection of ServiceDescription objects after calling one of the export methods.

System_CAPS_pubpropertyGeneratedXmlSchemas

Gets a set of XmlSchema objects after calling one of the export methods.

System_CAPS_pubpropertyPolicyVersion

Specifies the version of WS-Policy specification being used.(Inherited from MetadataExporter.)

System_CAPS_pubpropertyState

Gets a dictionary of objects used in the export of metadata.(Inherited from MetadataExporter.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExportContract(ContractDescription)

Exports metadata that describes only the contract information from the specified contract description.(Overrides MetadataExporter.ExportContract(ContractDescription).)

System_CAPS_pubmethodExportEndpoint(ServiceEndpoint)

Generates metadata about the specified endpoint.(Overrides MetadataExporter.ExportEndpoint(ServiceEndpoint).)

System_CAPS_pubmethodExportEndpoints(IEnumerable(Of ServiceEndpoint), XmlQualifiedName)

Generates metadata about a group of endpoints from a specified service.

System_CAPS_protmethodExportPolicy(ServiceEndpoint)

Converts policy assertions into a System.ServiceModel.Description.PolicyConversionContext object. (Inherited from MetadataExporter.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetGeneratedMetadata()

Returns an enumerable collection of generated MetadataSection objects.(Overrides MetadataExporter.GetGeneratedMetadata().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

Use the WsdlExporter class to transform ContractDescription or ServiceEndpoint objects into metadata represented by MetadataSection objects.

The WsdlExporter is used in a three-step process.

  1. Call the ExportContract, ExportEndpoint, or ExportEndpoints method, passing the appropriate parameters.

  2. Determine whether there are any export errors by checking the base Errors property.

  3. If there are no errors, use the GetGeneratedMetadata to get a collection of MetadataSection objects or get more specific versions of the metadata using the GeneratedWsdlDocuments or GeneratedXmlSchemas properties.

You can support exporting custom WSDL extensions by implementing the IWsdlExportExtension interface and custom policy assertions by implementing the IPolicyExportExtension interface. For details, see the documentation for those interfaces.

System_CAPS_noteNote

The WsdlExporter can only be used to export metadata from ContractDescription instances that contain Common Language Runtime (CLR) type information, such as a ContractDescription instance created using the ContractDescription.GetContract method or created as part of the ServiceDescription for a ServiceHost instance. You cannot use the WsdlExporter to export metadata from ContractDescription instances imported from service metadata or constructed without type information.

The following code example shows how to use the ExportEndpoint method to generate a set of MetadataSection objects from the endpoints in a collection of ServiceEndpoint objects called myServiceEndpoints.

Imports System
Imports System.ServiceModel
Imports System.ServiceModel.Description

Module Module1

    Sub Main()
        Dim exporter As New WsdlExporter()
        exporter.PolicyVersion = PolicyVersion.Policy15

        Dim myServiceEndpoints() As ServiceEndpoint = New ServiceEndpoint(1) {}
        Dim myDescription As New ContractDescription("myContract")
        myServiceEndpoints(0) = New ServiceEndpoint(myDescription, New BasicHttpBinding(), New EndpointAddress("http://localhost/myservice"))
        myServiceEndpoints(1) = New ServiceEndpoint(myDescription, New BasicHttpBinding(), New EndpointAddress("http://localhost/myservice"))

        'Export all endpoints for each endpoint in collection.
        For Each endpoint As ServiceEndpoint In myServiceEndpoints
            exporter.ExportEndpoint(endpoint)
        Next

        'If there are no errors, get the documents.
        Dim metadataDocs As MetadataSet
        metadataDocs = Nothing

        If (exporter.Errors.Count = 0) Then
            metadataDocs = exporter.GetGeneratedMetadata()
        End If
    End Sub

End Module

.NET Framework
Available since 3.0

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

Return to top
Show: