AddressHeader.CreateAddressHeader Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.1

Creates a new instance of the AddressHeader class.

Overloads

CreateAddressHeader(String, String, Object)	Creates a new instance of the AddressHeader class with a specified value, name and namespace.
CreateAddressHeader(String, String, Object, XmlObjectSerializer)	Creates a new instance of the AddressHeader class with a specified name and namespace that uses a specified formatter to serialize the information item from a specified object.

Remarks

The object that contains the information item is serialized into the address header by an XmlObjectSerializer object.

CreateAddressHeader(String, String, Object)

Source:

AddressHeader.cs

Creates a new instance of the AddressHeader class with a specified value, name and namespace.

C#

public static System.ServiceModel.Channels.AddressHeader CreateAddressHeader(string name, string ns, object value);

Parameters

name

String

The name of the address header.

ns

String

The namespace of the address header.

value

Object

The information item for the address header.

Returns

AddressHeader

The AddressHeader with the specified name and ns that contains the information item specified by value.

Exceptions

ArgumentNullException

The name is null or name.Length == 0.

Examples

The following example shows how to create an address header using this method.

C#

// Create address headers for special services and add them to an array
AddressHeader addressHeader1 = AddressHeader.CreateAddressHeader("specialservice1", "http://localhost:8000/service", 1);
AddressHeader addressHeader2 = AddressHeader.CreateAddressHeader("specialservice2", "http://localhost:8000/service", 2);
AddressHeader[] addressHeaders = new AddressHeader[2] { addressHeader1, addressHeader2 };

// Endpoint address constructor with URI and address headers
EndpointAddress endpointAddressWithHeaders = new EndpointAddress(
    new Uri("http://localhost/silverlightsamples/service1"), addressHeaders
    );

// Confirm adddressHeader1 is in endpointAddressWithHeaders - boolHeaders returns True.
AddressHeaderCollection addressHeaderCollection = endpointAddressWithHeaders.Headers;
bool boolHeaders = addressHeaderCollection.Contains(addressHeader1);

C#

// Create address headers for special services and add them to an array
AddressHeader addressHeader1 = AddressHeader.CreateAddressHeader("specialservice1", "http://localhost:8000/service", 1);
AddressHeader addressHeader2 = AddressHeader.CreateAddressHeader("specialservice2", "http://localhost:8000/service", 2);
AddressHeader[] addressHeaders = new AddressHeader[2] { addressHeader1, addressHeader2 };

// Endpoint address constructor with URI and address headers
EndpointAddress endpointAddressWithHeaders = new EndpointAddress(
    new Uri("http://localhost/silverlightsamples/service1"), addressHeaders
    );

// Confirm adddressHeader1 is in endpointAddressWithHeaders - boolHeaders returns True.
AddressHeaderCollection addressHeaderCollection = endpointAddressWithHeaders.Headers;
bool boolHeaders = addressHeaderCollection.Contains(addressHeader1);

CreateAddressHeader(String, String, Object, XmlObjectSerializer)

Source:

AddressHeader.cs

Creates a new instance of the AddressHeader class with a specified name and namespace that uses a specified formatter to serialize the information item from a specified object.

C#

public static System.ServiceModel.Channels.AddressHeader CreateAddressHeader(string name, string ns, object value, System.Runtime.Serialization.XmlObjectSerializer serializer);

Parameters

name

String

The name of the address header.

ns

String

The namespace of the address header.

value

Object

The information item for the address header.

serializer

XmlObjectSerializer

The XmlObjectSerializer used to serialize the specified object in the value parameter.

Returns

AddressHeader

The AddressHeader with the specified name and ns that contains the information item specified by value.

Exceptions

ArgumentNullException

name or serializer is null or name.Length == 0.

Examples

The following example shows how to create an address header using this method.

C#

//Create address headers with XmlObjectSerializer specified
XmlObjectSerializer serializer = new DataContractSerializer(typeof(int));
AddressHeader addressHeaderWithObjSer = AddressHeader.CreateAddressHeader("MyServiceName", "http://localhost:8000/service", 1, serializer);
int value = addressHeaderWithObjSer.GetValue<int>();

C#

//Create address headers with XmlObjectSerializer specified
XmlObjectSerializer serializer = new DataContractSerializer(typeof(int));
AddressHeader addressHeaderWithObjSer = AddressHeader.CreateAddressHeader("MyServiceName", "http://localhost:8000/service", 1, serializer);
int value = addressHeaderWithObjSer.GetValue<int>();