IUccCategoryInstance.IsPublishedByLocalEndpoint Property

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 the Boolean flag to determine whether this category instance is published by the local endpoint.

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

Syntax

'Declaration
ReadOnly Property IsPublishedByLocalEndpoint As Boolean

bool IsPublishedByLocalEndpoint { get; }

property bool IsPublishedByLocalEndpoint {
    bool get ();
}

/** @property */
boolean get_IsPublishedByLocalEndpoint ()

function get IsPublishedByLocalEndpoint () : boolean

Property Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type. This returns TRUE for a local endpoint and FALSE for a remote endpoint.

Remarks

Category instance values which are originated by the client and must be published to an Office Communications server are considered to be published by the local endpoint. An example of this is the aggregate state of the local user and published in the "state" category context. Self-published category instances that are provisioned to a client by an Office Communications server are not considered to be published by the local endpoint. An example of this is the "contacts" category that contains a local users' contact list.

Win32 COM/C++ Syntax

HRESULT get_IsPublishedByLocalEndpoint
(
   VARIANT_BOOL* pfIsPublishedByLocalEndpoint
);

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 displays a category instance's category context name on the computer system console if the received instance is published by the local endpoint.

if (pCategory.CategoryInstance.IsPublishedByLocalEndpoint)
{
   Console.WriteLine(
      "Local-endpoint-published category instance received" +
      pCategory.CategoryInstance.CategoryContext.Name);
}

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

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