ProtocolImporter Class
TOC
Collapse the table of content
Expand the table of content

ProtocolImporter Class

 
Use BaseTrue

Provides common functionality across communication protocols for generating classes for Web services.

Namespace:   System.Web.Services.Description
Assembly:  System.Web.Services (in System.Web.Services.dll)

System::Object
  System.Web.Services.Description::ProtocolImporter
    System.Web.Services.Description::SoapProtocolImporter

[PermissionSetAttribute(SecurityAction::InheritanceDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = "FullTrust")]
public ref class ProtocolImporter abstract 

NameDescription
System_CAPS_protmethodProtocolImporter()

Initializes a new instance of the ProtocolImporter class.

NameDescription
System_CAPS_pubpropertyAbstractSchemas

Gets the abstract XML schemas used by the associated ServiceDescriptionImporter instance.

System_CAPS_pubpropertyBinding

Gets the Web Services Description Language (WSDL) binding that the protocol importer is currently processing to generate a class.

System_CAPS_pubpropertyClassName

Gets the name of the binding class that is currently being generated.

System_CAPS_pubpropertyClassNames

Gets the CodeIdentifiers object that generates a unique name for the binding class that is currently being generated.

System_CAPS_pubpropertyCodeNamespace

Gets a representation of the .NET Framework namespace of the binding classes that are being generated.

System_CAPS_pubpropertyCodeTypeDeclaration

Gets a representation of the binding class that is currently being generated.

System_CAPS_pubpropertyConcreteSchemas

Gets the concrete XML schemas used by the associated ServiceDescriptionImporter instance.

System_CAPS_pubpropertyInputMessage

Gets the Web Services Description Language (WSDL) input message for the abstract operation that the protocol importer is currently processing to generate a method in a binding class.

System_CAPS_pubpropertyMethodName

Gets the name of the binding class method which that the protocol importer is currently generating.

System_CAPS_pubpropertyOperation

Gets the abstract Web Services Description Language (WSDL) operation that the protocol importer is currently processing to generate a method in a binding class.

System_CAPS_pubpropertyOperationBinding

Gets the Web Services Description Language (WSDL) operation binding that the protocol importer is currently processing to generate a method in a binding class.

System_CAPS_pubpropertyOutputMessage

Gets the Web Services Description Language (WSDL) output message for the abstract operation that the protocol importer is currently processing to generate a method in a binding class.

System_CAPS_pubpropertyPort

Gets a Web Services Description Language (WSDL) port that contains a reference to the binding that the protocol importer is currently processing to generate a binding class. If more than one port refers to the current binding, the current port is the one in which the binding has most recently been found.

System_CAPS_pubpropertyPortType

Gets the Web Services Description Language (WSDL) PortType that is implemented by the binding that the protocol importer is currently processing to generate a binding class.

System_CAPS_pubpropertyProtocolName

Abstract property that concrete derived classes must implement to get the name of the protocol being used.

System_CAPS_pubpropertySchemas

Gets all the XML schemas, both abstract and concrete, used by the associated ServiceDescriptionImporter instance.

System_CAPS_pubpropertyService

Gets the Web Services Description Language (WSDL) service that contains a reference to the binding that the protocol importer is currently processing to generate a binding class.

System_CAPS_pubpropertyServiceDescriptions

Gets the ServiceDescriptionCollection objects that belong to the associated ServiceDescriptionImporter instance that are searched for bindings from which to generate binding classes.

System_CAPS_pubpropertyStyle

Gets an enumeration value that indicates whether a client proxy class or an abstract server class is being generated. The values are Client and Server. The value is that of the associated ServiceDescriptionImporter instance's Style property.

System_CAPS_pubpropertyWarnings

Gets or sets a ServiceDescriptionImportWarnings enumeration value that indicates the types of warnings, if any, issued by the protocol importer while generating binding classes.

NameDescription
System_CAPS_pubmethodAddExtensionWarningComments(CodeCommentStatementCollection^, ServiceDescriptionFormatExtensionCollection^)

For each unhandled extension or XML element in the input extensions collection, turns on a RequiredExtensionsIgnored or OptionalExtensionsIgnored warning for each unhandled extension or XML element in the input extensions collection.

System_CAPS_protmethodBeginClass()

When overridden in a derived class, initializes the generation of a binding class.

System_CAPS_protmethodBeginNamespace()

When overridden in a derived class, performs namespace-wide initialization during code generation.

System_CAPS_protmethodEndClass()

When overridden in a derived class, processes a binding class.

System_CAPS_protmethodEndNamespace()

When overridden in a derived class, performs processing for an entire namespace.

System_CAPS_pubmethodEquals(Object^)

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

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_protmethodGenerateMethod()

When overridden in a derived class, generates method code for binding classes.

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_protmethodIsBindingSupported()

When overridden in a derived class, determines whether a class can be generated for the current binding.

System_CAPS_protmethodIsOperationFlowSupported(OperationFlow)

When overridden in a derived class, determines whether the current operation's operation flow is supported.

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_pubmethodOperationBindingSyntaxException(String^)

Produces an Exception indicating that the current OperationBinding instance for which a binding class is being generated is invalid within the target namespace.

System_CAPS_pubmethodOperationSyntaxException(String^)

Produces an Exception indicating that the current Operation instance for which a binding class is being generated is invalid within the target namespace.

System_CAPS_pubmethodToString()

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

System_CAPS_pubmethodUnsupportedBindingWarning(String^)

Turns on an UnsupportedBindingsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.

System_CAPS_pubmethodUnsupportedOperationBindingWarning(String^)

Turns on an UnsupportedOperationsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.

System_CAPS_pubmethodUnsupportedOperationWarning(String^)

Turns on an UnsupportedOperationsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.

The abstract ProtocolImporter class and its concrete derived classes generate client proxy code or abstract server code according to a specified communication protocol. ProtocolImporter provides common functionality regardless of the protocol. Within a given protocol, a concrete derived class generates a class for each supported binding defined in a Web Services Description Language (WSDL) document. Typically, instead of directly invoking classes derived from ProtocolImporter, a developer uses these classes indirectly through the ServiceDescriptionImporter class.

.NET Framework
Available since 1.1

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:
© 2016 Microsoft