.NET Framework Class Library
WebServiceAttribute Class

Used to add additional information to an XML Web service, such as a string describing its functionality.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.ServicesWebServiceAttribute

Namespace:   System.Web.Services
Assembly:  System.Web.Services (in System.Web.Services.dll)
Syntax
<[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_0_0_1%].Class Or [%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_0_0_2%].Interface)> _
Public NotInheritable Class WebServiceAttribute _
	Inherits [%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_1_0_1%].Class|[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_1_0_2%].Interface)]
public sealed class WebServiceAttribute : [%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_2_0_1%]::Class|[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_2_0_2%]::Interface)]
public ref class WebServiceAttribute sealed : public [%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_3_0_2%].Class|[%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_3_0_3%].Interface)>]
type WebServiceAttribute =  
    class 
        inherit [%$TOPIC/wdcyzxkx_en-us_VS_110_2_0_3_0_4%] 
    end

The WebServiceAttribute type exposes the following members.

Constructors
  NameDescription
Public method WebServiceAttributeInitializes a new instance of the WebServiceAttribute class.
Top
Properties
  NameDescription
Public property DescriptionA descriptive message for the XML Web service.
Public property NameGets or sets the name of the XML Web service.
Public property NamespaceGets or sets the default XML namespace to use for the XML Web service.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Fields
  NameDescription
Public field Static member DefaultNamespaceThe default value for the Namespace property. This field is constant.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

The WebServiceAttribute is not required for an XML Web service to be published and executed. You can use the WebServiceAttribute to specify a name for the XML Web service that is not restricted by the rules for a common language runtime identifier, which is used in the service description and the Service help page for the XML Web service.

An XML Web service should change its default XML namespace before it is made public. Each XML Web service needs a unique XML namespace to identify it so that client applications can distinguish it from other services on the Web. http://tempuri.org/ is available for XML Web services that are under development, but published XML Web services should use a more permanent namespace.

Your XML Web service should be identified by a XML namespace that you control. For example, you could use your company's Internet domain name as part of the XML namespace. Although many XML Web service XML namespaces look like URLs, they need not point to an actual resource on the Web. (XML Web service XML namespaces are URIs.) For XML Web services created using ASP.NET, the default XML namespace can be changed using Namespace property.

For more information about using attributes, see Extending Metadata Using Attributes.

Examples

The following example sets the Description property of the WebServiceAttribute to " Common Server Variables " and sets the XML namespace to http://www.microsoft.com/.

<%@ WebService Language="VB" Class= "ServerVariables"%>

Imports System
Imports System.Web.Services

<WebService(Description := "Common Server Variables", _
 Namespace := "http://www.contoso.com/")> _
Public Class ServerVariables
    Inherits WebService 

    <WebMethod(Description := "Obtains the Computer Machine Name", _
        EnableSession := False)> _
    Public Function GetMachineName() As String

        Return Server.MachineName
    End Function
End Class
 
<%@ WebService Language="C#" Class= "ServerVariables"%>

 using System;
 using System.Web.Services;

 [ WebService(Description="Common Server Variables",Namespace="http://www.contoso.com/")]
 public class ServerVariables: WebService {


    [ WebMethod(Description="Obtains the Server Computer Name",EnableSession=false)]
    public string GetMachineName() {
       return Server.MachineName;
    }   
 }
 
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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.