AddMessageHeaderItem Method

Adds a SoapHeader item to the SOAP header before the WCF client sends a request.

Syntax

client.wcfConnectionObject.SoapMessageHeader.AddMessageHeaderItem (string ItemName, string ItemNamespace, string ItemValue, PBWCF.WCFHMAC ItemEncryptAlgorithm!, string EncryptKey)

Parameters

SoapMessageHeader – an instance of the WCFSoapMessageHeader class.
ItemName – a string for the name of the SoapHeader item to add.
ItemNamespace – a string for the namespace of the SoapHeader item.
ItemValue – a string for the value of the SoapHeader item.
ItemEncryptAlgorithm – an enumerated value of the type PBWCF.WCFHMAC for the algorithm to encrypt the ItemValue.
EncryptKey – a string for the key to encrypt the ItemValue.

Returns

Boolean. Returns true if successful, otherwise returns false.

Examples

Setting values in the wcfConnectionObject – Add a header to a request message sent to Amazon Web Services with code like this:

client.wcfConnectionObject.SoapMessageHeader.AddMessageHeaderItem("AWSAccessKeyId","http://security.amazonaws.com/doc/2007-01-01/","My access key",PBWCF.WCFHMAC.NONE!,"")
client.wcfConnectionObject.SoapMessageHeader.AddMessageHeaderItem("Signature","http://security.amazonaws.com/doc/2007-01-01/","My secret key", PBWCF.WCFHMAC.HMACSHA256!, "")

Setting values in an instance of WCFSoapMessageHeader – Add a header sent to the same service using:

WCFSoapMessageHeader Header
Header = create WCFSoapMessageHeader
Header.AddMessageHeaderItem("AWSAccessKeyId","http://security.amazonaws.com/doc/2007-01-01/","My access key",PBWCF.WCFHMAC.NONE!,"")
Header. .AddMessageHeaderItem("Signature","http://security.amazonaws.com/doc/2007-01-01/","My secret key", PBWCF.WCFHMAC.HMACSHA256!, "")
client.wcfConnectionObject.SoapMessageHeader = Header

Usage

If you use encryption, the format for a SoapHeader item in the request sent by the WCF client is:

  <ItemName xmlns=”ItemNamespace”>EncryptedItemValue</ItemName>