IUccPublication.Publish 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.

Publishes the category instances in this publication session.

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

Syntax

'Declaration
Sub Publish ( _
    pOperationContext As UccOperationContext _
)

void Publish (
    UccOperationContext pOperationContext
)

void Publish (
    UccOperationContext^ pOperationContext
)

void Publish (
    UccOperationContext pOperationContext
)

function Publish (
    pOperationContext : UccOperationContext
)

Parameters

  • pOperationContext
    A value of the IUccOperationContext* (UccOperationContext, for a .NET application) type. The default value is NULL. This can be used to specify application-defined context for this publication request.

Remarks

Subscribers begin to receive the category instances or the updates after this method is called. An application can verify the status of completion of this request by catching the OnPublish event as defined in _IUccPublicationEvent. The publication object can not be used for further publication operations. The OnPublish event handler is a good place to destroy the used publication object.

Win32 COM/C++ Syntax

HRESULT Publish
(
   IUccOperationContext* pOperationContext
);

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 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#