IUccPublication.AddPublishableCategoryInstance Method

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.

Adds a new publishable category instance to the publication.

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

Syntax

'Declaration
Sub AddPublishableCategoryInstance ( _
    pPublishableCategoryInstance As IUccCategoryInstance _
)

void AddPublishableCategoryInstance (
    IUccCategoryInstance pPublishableCategoryInstance
)

void AddPublishableCategoryInstance (
    IUccCategoryInstance^ pPublishableCategoryInstance
)

void AddPublishableCategoryInstance (
    IUccCategoryInstance pPublishableCategoryInstance
)

function AddPublishableCategoryInstance (
    pPublishableCategoryInstance : IUccCategoryInstance
)

Parameters

• pPublishableCategoryInstance
  A value of the IUccCategoryInstance* (IUccCategoryInstance, for a .NET application) type. This specifies a new category instance added to this publication session.

Remarks

The IUccCategoryInstance interface parameter instance must be in a publishable state. A publishable category instance is a category instance that has been obtained with a call into CreatePublishableCategoryInstance on a publication manager instance or CreatePublishableCategoryInstance on an existing category instance. Passing a non-publishable category instance to AddPublishableCategoryInstance results in a COM exception.

Win32 COM/C++ Syntax

HRESULT AddPublishableCategoryInstance
(
   IUccCategoryInstance* pPublishableCategoryInstance
);

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 takes a publishable category instance as a method argument, creates a publication object, advises for publication events, adds the passed category instance to the publication, and publishes the publication.

private void PublishCategoryInstance(IUccCategoryInstance cat)
{
   IUccPublication pub = pubMgr.CreatePublication() as IUccPublication;
   if (pub != null)
   {
      UCC_Advise<_IUccPublicationEvent>(pub, this);
      pub.AddPublishableCategoryInstance(cat);
      pub.Publish(null);
   }
}

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

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

Other Resources

Code Listing: Basic Event Registration and Other Helper Methods in C#