IUccPublicationManager.CreatePublication 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 publication session.

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

Syntax

'Declaration
Function CreatePublication As IUccPublication

IUccPublication CreatePublication ()

IUccPublication^ CreatePublication ()

IUccPublication CreatePublication ()

function CreatePublication () : IUccPublication

Return Value

A value of the IUccPublication** (IUccPublication, for a .NET application) type. This returns an empty publication session.

Remarks

The publication object can be used for a single publication. It is a good idea to declare an IUccPublication object within a method whose purpose is to publish a collection of category instances. When the execution has returned to calling code, the method has gone out of scope and the temporary publication object is destroyed.

The publication raises events on publication. You must advise for publication events with the IUccPublication object as the event source.

Win32 COM/C++ Syntax

HRESULT CreatePublication
(
   IUccPublication** ppPublication
);

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 simple example accepts a single category instance, creates a publication object using the publication manager, advises for publication events, and publishes the category instance.

private void PublishCategoryInstance(IUccCategoryInstance cat)
{
   //create publication object
   IUccPublication pub = pubMgr.CreatePublication() as IUccPublication;
   if (pub != null)
   {
      //advise for publication events to catch OnPublish
      UCC_Advise<_IUccPublicationEvent>(pub, this);

      //add category instance to publish
      pub.AddPublishableCategoryInstance(cat);

      //publish new publication
      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

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

Other Resources

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