Message Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides an abstract definition of data passed by an XML Web service. This class cannot be inherited.
public ref class Message sealed : System::Web::Services::Description::DocumentableItem
public ref class Message sealed : System::Web::Services::Description::NamedItem
public sealed class Message : System.Web.Services.Description.DocumentableItem
[System.Web.Services.Configuration.XmlFormatExtensionPoint("Extensions")]
public sealed class Message : System.Web.Services.Description.NamedItem
type Message = class
inherit DocumentableItem
[<System.Web.Services.Configuration.XmlFormatExtensionPoint("Extensions")>]
type Message = class
inherit NamedItem
Public NotInheritable Class Message
Inherits DocumentableItem
Public NotInheritable Class Message
Inherits NamedItem
- Inheritance
- Inheritance
- Attributes
Examples
// Creates a Message with name = messageName having one MessagePart
// with name = partName.
public:
static Message^ CreateMessage( String^ messageName, String^ partName, String^ element, String^ targetNamespace )
{
Message^ myMessage = gcnew Message;
myMessage->Name = messageName;
MessagePart^ myMessagePart = gcnew MessagePart;
myMessagePart->Name = partName;
myMessagePart->Element = gcnew XmlQualifiedName( element,targetNamespace );
myMessage->Parts->Add( myMessagePart );
return myMessage;
}
// Creates a Message with name = messageName having one MessagePart
// with name = partName.
public static Message CreateMessage(string messageName,string partName,
string element,string targetNamespace)
{
Message myMessage = new Message();
myMessage.Name = messageName;
MessagePart myMessagePart = new MessagePart();
myMessagePart.Name = partName;
myMessagePart.Element = new XmlQualifiedName(element,targetNamespace);
myMessage.Parts.Add(myMessagePart);
return myMessage;
}
' Creates a Message with name = messageName having one MessagePart
' with name = partName.
Public Shared Function CreateMessage(messageName As String, _
partName As String, element As String, targetNamespace As String) _
As Message
Dim myMessage As New Message()
myMessage.Name = messageName
Dim myMessagePart As New MessagePart()
myMessagePart.Name = partName
myMessagePart.Element = New XmlQualifiedName(element, targetNamespace)
myMessage.Parts.Add(myMessagePart)
Return myMessage
End Function 'CreateMessage
Remarks
A Message can contain either document-oriented or procedure-oriented information. Procedure-oriented messages contain parameters and return values, while document-oriented messages contain documents.
The Message class corresponds to a Web Services Description Language (WSDL) message
element enclosed by the definitions
root element. For more information about WSDL, see the WSDL specification.
Constructors
Message() |
Initializes a new instance of the Message class. |
Properties
Documentation |
Gets or sets the text documentation for the instance of the DocumentableItem. (Inherited from DocumentableItem) |
DocumentationElement |
Gets or sets the documentation element for the DocumentableItem. (Inherited from DocumentableItem) |
ExtensibleAttributes |
Gets or sets an array of type XmlAttribute that represents attribute extensions of WSDL to comply with Web Services Interoperability (WS-I) Basic Profile 1.1. (Inherited from DocumentableItem) |
Extensions |
Gets the ServiceDescriptionFormatExtensionCollection associated with this Message. |
Extensions |
Gets the ServiceDescriptionFormatExtensionCollection associated with this DocumentableItem. (Inherited from DocumentableItem) |
Name |
Gets or sets the name of the current Message. |
Name |
Gets or sets the name of the item. (Inherited from NamedItem) |
Namespaces |
Gets or sets the dictionary of namespace prefixes and namespaces used to preserve namespace prefixes and namespaces when a ServiceDescription object is constructed. (Inherited from DocumentableItem) |
Parts |
Gets the collection of the MessagePart objects contained in the Message. |
ServiceDescription |
Gets the ServiceDescription of which the current Message is a member. |
Methods
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
FindPartByName(String) |
Searches the MessagePartCollection returned by the Parts property, and returns the named MessagePart. |
FindPartsByName(String[]) |
Searches the MessagePartCollection returned by the Parts property and returns an array of type MessagePart that contains the named instances. |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |