IUccPresentity.RefreshPresence 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.

Refreshes the presence information of this presentity.

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

Syntax

'Declaration
Sub RefreshPresence ( _
    pCtxt As UccOperationContext _
)

void RefreshPresence (
    UccOperationContext pCtxt
)

void RefreshPresence (
    UccOperationContext^ pCtxt
)

void RefreshPresence (
    UccOperationContext pCtxt
)

function RefreshPresence (
    pCtxt : UccOperationContext
)

Parameters

Remarks

This is an asynchronous call. The operation status (success or failure) is returned in an OnSubscribe event. In order to receive this event, the client must advise for _IUccSubscriptionEvents prior to refreshing the presentities presence.

Win32 COM/C++ Syntax

HRESULT RefreshPresence
(
   IUccOperationContext* pCtxt
);

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 accepts an instance of IUccPresentity and calls into RefreshPresence on that presentity.

public void RefreshPresentity(UccPresentity pContact)
{
   UccOperationContext refreshContext = new UccOperationContext();
   UccContext c = new UccContextClass();
   c.AddNamedProperty("Refresh Uri", pContact.Uri.AddressOfRecord);
   refreshContext.Initialize(1, c);

   pContact.RefreshPresence(refreshContext);
}

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

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