Share via

IUccSignalingMessage.AddHeaderField Method

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Creates a new header field to be added to the message header fields collection.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Function AddHeaderField ( _
    bstrName As String, _
    bstrValue As String _
) As UccSignalingHeaderField

UccSignalingHeaderField AddHeaderField (
    string bstrName,
    string bstrValue
)

UccSignalingHeaderField^ AddHeaderField (
    String^ bstrName, 
    String^ bstrValue
)

UccSignalingHeaderField AddHeaderField (
    String bstrName, 
    String bstrValue
)

function AddHeaderField (
    bstrName : String, 
    bstrValue : String
) : UccSignalingHeaderField

Parameters

  • bstrName
    A value of the BSTR (string, for a .NET application) type. This is the name of the new header field.
  • bstrValue
    A value of the BSTR (string, for a .NET application) type. This is the value of the new header field.

Return Value

A value of the IUccSignalingHeaderField** (IUccSignalingHeaderField, for a .NET application) type. This is the header field object encapsulating the given name-value pair.

Remarks

A message header field is an name-value pair. The value can be parsed further into a set of parameters separated by semicolons.

Win32 COM/C++ Syntax

HRESULT AddHeaderField
(
   BSTR bstrName,
   BSTR bstrValue,
   IUccSignalingHeaderField** ppHeaderField
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Error Codes.

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccSignalingMessage Interface
IUccSignalingMessage Members
Microsoft.Office.Interop.UccApi Namespace