Share via

IUccIncomingInstantMessageEvent.IsBroadcast 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.

Gets a flag indicating whether the message is sent to all the participants in the session.

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

Syntax

'Declaration
Function IsBroadcast As Boolean

bool IsBroadcast ()

bool IsBroadcast ()

boolean IsBroadcast ()

function IsBroadcast () : boolean

Return Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type.

Remarks

If a message is directed to the local participant alone, rather than to all conference participants, this property value is False.

Win32 COM/C++ Syntax

HRESULT IsBroadcast
(
   VARIANT_BOOL* pVal
);

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 Trace and Handle Errors in Unified Communications Client API .

Example

The following example can be called from an OnInstantMessageReceived event handler, passing in an instance of IUccIncomingInstantMessageEvent. The example updates a client TextBox with both the IsBroadcast property of the sending participant and the message itself.

/// <summary>
/// Appends received text to the end of a text box, scrolls
/// the text box if necessary, and moves selection curser to bottom of box 
/// </summary>
/// <param name="pIMEvent">UccIncomingInstantMessageEvent received in OnInstantMessageReceived</param>
/// <param name="pBoxToFill"></param>
/// <returns></returns>
private void ProcessIncomingIM(
    UccIncomingInstantMessageEvent pIMEvent, 
    ref TextBox pBoxToFill)
{
    if (pIMEvent.ContentType == "text/plain")
    {
        //append text box with message content
        pBoxToFill.AppendText(
            pIMEvent.Content + 
            " Broadcast Message: " + 
            pIMEvent.IsBroadcast().ToString());
    }
}

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

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