IUccPublicationManager.CreatePublishableCategoryInstance 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.

Creates a publishable category instance to go into a publication.

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

Syntax

'Declaration
Function CreatePublishableCategoryInstance ( _
    bstrCategoryName As String, _
    lContainerId As Integer, _
    lInstance As Integer, _
    enExpireType As UCC_CATEGORY_INSTANCE_EXPIRE_TYPE, _
    lExpireTime As Integer _
) As IUccCategoryInstance

IUccCategoryInstance CreatePublishableCategoryInstance (
    string bstrCategoryName,
    int lContainerId,
    int lInstance,
    UCC_CATEGORY_INSTANCE_EXPIRE_TYPE enExpireType,
    int lExpireTime
)

IUccCategoryInstance^ CreatePublishableCategoryInstance (
    String^ bstrCategoryName, 
    int lContainerId, 
    int lInstance, 
    UCC_CATEGORY_INSTANCE_EXPIRE_TYPE enExpireType, 
    int lExpireTime
)

IUccCategoryInstance CreatePublishableCategoryInstance (
    String bstrCategoryName, 
    int lContainerId, 
    int lInstance, 
    UCC_CATEGORY_INSTANCE_EXPIRE_TYPE enExpireType, 
    int lExpireTime
)

function CreatePublishableCategoryInstance (
    bstrCategoryName : String, 
    lContainerId : int, 
    lInstance : int, 
    enExpireType : UCC_CATEGORY_INSTANCE_EXPIRE_TYPE, 
    lExpireTime : int
) : IUccCategoryInstance

Parameters

• bstrCategoryName
  A value of the BSTR (string, for a .NET application) type. This specifies the category name.

• lContainerId
  A value of the LONG (int, for a .NET application) type. This specifies the ID of the container of this category instance.

• lInstance
  A value of the LONG (int, for a .NET application) type. This specifies the instance ID of this category instance.

• enExpireType
  A value of the UCC_CATEGORY_INSTANCE_EXPIRE_TYPE type. This specifies the expiration type of this category instance.

• lExpireTime
  A value of the LONG (int, for a .NET application) type. This specifies the expiration time of this category instance if the expiration type is UCC_CATEGORY_INSTANCE_EXPIRE_TYPE.UCCCIET_TIME. Set this to –1 for other expiration types.

Return Value

A value of the IUccCategoryInstance** (IUccCategoryInstance, for a .NET application) type. This returns the newly created category instance that can be used for publication.

Remarks

Win32 COM/C++ Syntax

HRESULT CreatePublishableCategoryInstance
(
   BSTR bstrCategoryName,
   LONG lContainerId,
   LONG lInstance,
   UCC_CATEGORY_INSTANCE_EXPIRE_TYPE enExpireType,
   LONG lExpireTime,
   IUccCategoryInstance** ppCategoryInstance
);

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 creates a new publishable category instance for a custom category context. This is the initial publication of the category instance. For this reason, an instance Id is not assigned by the client. Office Communications Server assigns an instance id upon receipt of the publication request. The new category instance is returned to the client in a future subscription event. The returned category instance is populated with the instance Id assigned by Office Communications Server.

string custCategoryName = pubMgr.GetPresenceCategoryName(
   UCC_PRESENCE_CATEGORY_TYPE.UCCPCT_UC_USERPROPERTIES);
UccCategoryInstance pubInstance = pubMgr.CreatePublishableCategoryInstance(
   custCategoryName,
   100,
   0, // in case of "containers", instance id = container #
   UCC_CATEGORY_INSTANCE_EXPIRE_TYPE
   .UCCCIET_USER,
   0);

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